ListPrivateZones - 获取域名列表--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

TrafficRoute DNS 套件

域名管理

ListPrivateZones - 获取域名列表

获取域名的列表。

使用说明

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	ListPrivateZones	要执行的操作，取值：ListPrivateZones。
Version	String	是	2022-06-01	API的版本，取值：2022-06-01。
PageNumber	Integer	否	1	页码。页数由获取的域名总数和 `PageSize` 确定。默认为 1。
PageSize	Integer	否	10	每页包含的域名的数量。默认为 10。最大值为 200。
TagFilters	Array of Object	否	TagFilters.1={"Key":"k1","Values":["v1", "v2"]}&TagFilters.2={"Key":"k2","Values":["v1", "v2"]}	域名的标签。您需要指定： N：表示 `TagFilters` 的序号，取值范围：1～10。`N` 应按照从小到大的顺序，且必须为连续的数字。标签键：例如 `"Key":"k1"`。如果您指定多个标签键，私网解析 PrivateZone 会查询同时包含所有指定标签键的域名。标签值：例如 `Values":["v1", "v2"]`。标签值数组的长度取值范围为 1～3。您可不传入 `Values`，表示查询时 `Values` 不作为查询条件。如果您把仅包含空字符串的数组传入 `Values` ，私网解析 PrivateZone 会查询 `Values` 为空的标签。如果一个 `Values` 包含多个值，这些值之间的关系为逻辑或（OR）。
ProjectName	String	否	default	域名所属的项目名称。如果您不传入该参数，该参数不作为查询条件。
ZIDs.N	Array of Integer	否	ZIDs.1=123&ZIDs.2=234	域名 ID。您可以输入一个或多个域名 ID，例如 `ZIDs.1=123&ZIDs.2=234`。您最多输入 100 个域名 ID。您需要确保 ZIDs 后的数字 N 从小到大且是连续的。如果您不传入该参数，该参数不作为查询条件。
VpcTrns	Array of String	否	["trn:vpc:cn-beijing:12345678:vpc/vpc-3reow******hxad79k"]	域名所关联的一个或多个 VPC 的 TRN。格式为 `trn:vpc:region:accountId:vpc/vpcId`。如果您需要验证子用户是否对域名关联的 VPC 所在的项目有操作权限，您需要传入该参数。
SearchMode	String	否	LIKE	查询模式。包括以下模式： LIKE（默认）：模糊查询。 EXACT：精确查询。
ZoneName	String	否	example.com	查询域名使用的关键字，例如 `example.com`。如果您不传入该参数，该参数不作为查询条件。
RecursionMode	Boolean	否	true	域名是否开启了递归解析。 true：域名开启了递归解析。 false：域名未开启递归解析。如果您不传入该参数，该参数不作为查询条件。
LineMode	Integer	否	0	是否开启负载均衡。 0：关闭负载均衡。 1：开启负载均衡。 2：该枚举值已废弃。 3：该枚举值已废弃。如果您不传入该参数，该参数不作为查询条件。
VpcID	String	否	vpc-123456	关联该域名的 VPC ID。如果您不传入该参数，该参数不作为查询条件。
Region	String	否	cn-beijing	域名生效的地域。如果您不传入该参数，该参数不作为查询条件。
ZIDs	Array of Long	否	ZIDs.1=123&ZIDs.2=234	域名 ID。您可以输入一个或多个域名 ID，例如 `ZIDs.1=123&ZIDs.2=234`。您最多输入 100 个域名 ID。您需要确保 ZIDs 后的数字 N 从小到大且是连续的。如果您不传入该参数，该参数不作为查询条件。

返回参数

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

参数	类型	示例值	描述
Total	Integer	10	域名数量。
Zones	Array of Object	无	域名列表。
PageNumber	Integer	1	Zones 展示的域名所在的页码。
PageSize	Integer	10	每页包含的域名的数量。

请求示例

GET https://private-zone.volcengineapi.com/?Action=ListPrivateZones&Version=2022-06-01&PageNumber=1&PageSize=1&ZoneName=example

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202309141706528A3C27DED8770CD641CE",
        "Action": "ListPrivateZones",
        "Version": "2022-06-01",
        "Service": "private_zone",
        "Region": "cn-north-1"
    },
    "Result": {
        "Zones": [
            {
                "CreatedAt": "2023-09-14T16:54:40+08:00",
                "UpdatedAt": "2023-09-14T16:54:40+08:00",
                "ZID": 37424,
                "ZoneName": "example.com",
                "Remark": "",
                "RecursionMode": false,
                "RecordCount": 1,
                "LineMode": 0,
                "LastOperator": "21xxxxx1",
                "Region": [
                    "华北1（北京）|cn-north-1"
                ],
                "AccountID": "2100054541",
                "ProjectName": "default",
                "Tags": [
                    {
                        "Key": "key1",
                        "Value": "value1"
                    }
                ],
                "ResourceID": "386457"
            }
        ],
        "Total": 402,
        "PageNumber": 1,
        "PageSize": 1
    }
}

错误码

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

状态码	错误码	错误信息	说明
400	ErrRegionNotSupport	%s of [%s] not supported by private_zone	private_zone不支持[%s]地域的%s
400	ErrParamInvalid	validation fail: params:[%s] , value:[%v]	参数校验失败
400	ErrAccountInArrears	this account in arrears, you cannot open this service. Please recharge your account	您的账号已欠费，无法使用该服务
400	AccountInArrears	您的账户已欠费，无法开通此服务！请前往账户充值	您的账户已欠费，无法开通此服务
500	ErrInternalServer	server internal error	服务内部错误

最近更新时间：2025.06.23 20:22:16

这个页面对您有帮助吗？

有用

无用