QueryPrivateZone - 获取域名的详细信息--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

导航

TrafficRoute DNS 套件

QueryPrivateZone - 获取域名的详细信息

最近更新时间：2025.05.22 19:59:23首次发布时间：2023.02.08 13:11:44

获取一个域名的详细信息。

使用说明

请求频率：每秒最多调用 20 次。

请求说明

请求方式：GET
请求地址：https://private-zone.volcengineapi.com/?Action=QueryPrivateZone?Version=2022-06-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

除了以下参数，您还需要对请求进行鉴权。

参数	类型	是否必填	示例值	描述
Action	String	是	QueryPrivateZone	要执行的操作，取值：QueryPrivateZone。
Version	String	是	2022-06-01	API的版本，取值：2022-06-01。
ZID	Long	是	1234	域名的 ID。您可以通过以下 API 获取： CreatePrivateZone API ListPrivateZones API

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
BindVPCs	Array of Object	无	域名关联的 VPC。
CreatedAt	String	2022-10-17T19:10:57+08:00	域名的创建时间。
LastOperator	String	2100054541	表示添加该域名的火山引擎账号的 ID。如果是子账号添加该域名，该参数的值是子账号的 ID。
ProjectName	String	default	域名所属的项目名称。
LineMode	Integer	1	域名是否开启了智能解析和负载均衡。 0：域名关闭了智能解析和负载均衡。 1：域名开启了负载均衡，同时关闭了智能解析。 2：域名关闭了负载均衡，同时开启了智能解析。 3：域名开启了智能解析和负载均衡。
RecordCount	Integer	10	解析记录的数量。
RecursionMode	Boolean	true	域名是否开启了递归解析。 true：域名开启了递归解析。 false：域名未开启递归解析。
Region	Array of String	[ "华北2（北京）\|cn-beijing" ]	VPC 所在的地域。
Remark	String	remark	域名备注。
Tags	Array of Object	无	域名所属的一个或多个标签。如果该域名没有标签，Tags 参数不会被显示。
UpdatedAt	String	2022-10-17T19:10:57+08:00	域名的更新时间。
ZID	Integer	1234	域名的 ID。
ZoneName	String	example.com	域名。

请求示例

GET https://private-zone.volcengineapi.com/?Action=QueryPrivateZone&Version=2022-06-01&ZID=367

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022121316005201017425518105440B1D",
        "Action": "QueryPrivateZone",
        "Version": "2022-06-01",
        "Service": "private_zone",
        "Region": "cn"
    },
    "Result": {
        "CreatedAt": "2022-10-17T19:10:57+08:00",
        "UpdatedAt": "2022-12-07T18:10:11+08:00",
        "ZID": 50627,
        "ZoneName": "internal.com",
        "Remark": "",
        "RecursionMode": false,
        "RecordCount": 2,
        "LineMode": 2,
        "LastOperator": "2100054541",
        "Region": [
            "华北2（北京）|cn-beijing"
        ],
        "BindVPCs": [
            {
                "ID": "vpc-2d6si87atfh1c58ozfd0nzq8k",
                "Region": "cn-beijing",
                "RegionName": "华北2（北京）",
                "AccountID": "2100054541"
            }
        ],
        "AccountID": "2100054541",
        "ProjectName": "default",
        "Tags": [
            {
                "Key": "key1",
                "Value": "value1"
            }
        ],
        "ResourceID": ""
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	ErrZoneNotFound	zone not found	未找到域名
500	ErrInternalServer	server internal error	服务内部错误