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

文档中心

立即注册

导航

TrafficRoute DNS 套件

QueryPrivateZone-获取域名的详细信息

最近更新时间：2024.11.20 11:13:11首次发布时间：2023.02.08 13:11:44

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

请求说明

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

请求参数

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

Query

名称	类型	是否必选	示例值	描述
Action	String	是	`QueryPrivateZone`	API 的名称。该参数的取值是 `QueryPrivateZone`。
Version	String	是	`2022-06-01`	API 的版本。该参数的取值是 `2022-06-01`。
ZID	Integer	是	`1234`	域名的 ID。您可以通过以下 API 获取： CreatePrivateZone API ListPrivateZones API

返回参数

ResponseMetadata 对象

名称	类型	描述
RequestId	String	标识本次请求的 ID。
Action	String	Action 查询参数的值。
Version	String	API 版本。
Service	String	服务类型。
Region	String	服务所在地域。

Result 对象

名称	类型	描述
ZID	Integer	域名的 ID。
CreatedAt	String	域名的创建时间。
UpdatedAt	String	域名的更新时间。
ZoneName	String	域名。
Remark	String	域名备注。
RecursionMode	Boolean	域名是否开启了递归解析。 true：域名开启了递归解析。 false：域名未开启递归解析。
LineMode	Integer	域名是否开启了智能解析和负载均衡。 0：域名关闭了智能解析和负载均衡。 1：域名开启了负载均衡，同时关闭了智能解析。 2：域名关闭了负载均衡，同时开启了智能解析。 3：域名开启了智能解析和负载均衡。
RecordCount	Integer	解析记录的数量。
BindVPCs	Array of Objects	域名绑定的 VPC。
Region	String[]	域名的生效地域。
LastOperator	String	表示最后更新该域名的火山引擎账号的 ID。
IsGlobal	Boolean	该参数无实际意义。您可以忽略该参数。
ProjectName	String	域名所属的项目名称。
Tags	Array of objects	域名所属的一个或多个标签。

示例

请求示例

GET https://open.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": {
        "ZID": 50627,
        "CreatedAt": "2022-10-17T19:10:57+08:00",
        "UpdatedAt": "2022-12-07T18:10:11+08:00",
        "ZoneName": "internal.com",
        "Remark": "",
        "RecursionMode": false,
        "LineMode": 2,
        "RecordCount": 2,
        "BindVPCs": [
            {
                "ID": "vpc-2d6si87atfh1c58ozfd0nzq8k",
                "Region": "cn-beijing",
                "RegionName": "华北2（北京）",
                "AccountID": "2100054541"
            }
        ],
        "Region": [
            "华北2（北京）|cn-beijing"
        ],
        "LastOperator": "2100054541",
        "IsGlobal": false,
        "ProjectName": "default",
        "Tags": null
    }
}

错误码

您可访问公共错误码，获取详细信息。