TrafficRoute DNS 套件
TrafficRoute DNS 套件
私网解析
请输入
- 文档首页
TrafficRoute DNS 套件API 参考域名管理ListPrivateZones - 获取域名列表
复制全文
下载 pdfListPrivateZones - 获取域名列表
文档反馈
问问助手获取域名的列表。
使用说明
请求频率：每秒最多调用 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 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）。
Key string 必选 示例值：k1
标签的键。
Values string[] 可选 示例值：["v1", "v2"]
标签的值。
ProjectName string 可选 示例值：default
域名所属的项目名称。如果您不传入该参数，该参数不作为查询条件。
ZIDs.N integer[] 可选 示例值：ZIDs.1=123&ZIDs.2=234
域名 ID。您可以输入一个或多个域名 ID，例如 ZIDs.1=123&ZIDs.2=234。您最多输入 100 个域名 ID。您需要确保 ZIDs 后的数字 N 从小到大且是连续的。如果您不传入该参数，该参数不作为查询条件。
VpcTrns 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 long[] 可选 示例值：ZIDs.1=123&ZIDs.2=234
域名 ID。您可以输入一个或多个域名 ID，例如 ZIDs.1=123&ZIDs.2=234。您最多输入 100 个域名 ID。您需要确保 ZIDs 后的数字 N 从小到大且是连续的。如果您不传入该参数，该参数不作为查询条件。
返回参数
Total integer 示例值：10
域名数量。
Zones object[] 示例值：无
域名列表。
CreatedAt string 示例值：2023-09-14T16:54:40+08:00
域名的创建时间。
UpdatedAt string 示例值：2023-09-14T16:54:40+08:00
域名的更新时间。
ZID long 示例值：1234
域名的ID。
ZoneName string 示例值：example.com
域名。
Remark string 示例值：remark
域名备注。
RecordCount integer 示例值：10
解析记录的数量。
RecursionMode boolean 示例值：true
域名是否开启了递归解析。
- true：域名开启了递归解析。
- false：域名未开启递归解析。
LineMode integer 示例值：0
是否开启负载均衡。
- 0：关闭负载均衡。
- 1：开启负载均衡。
- 2：该枚举值已废弃。
- 3：该枚举值已废弃。
LastOperator string 示例值：2100001
表示添加该域名的火山引擎账号的 ID。如果是子账号添加该域名，该参数的值是子账号的 ID。
Region string[] 示例值：[ "华北1（北京）|cn-north-1" ]
域名的生效地域。
ProjectName string 示例值：default
域名所属的项目名称。
Tags object[] 示例值：无
域名所属的一个或多个标签。如果该域名没有标签，Tags 参数不会被显示。
Key string 示例值：key
标签的键。
Value string 示例值：value
标签的值。
PageNumber integer 示例值：1
Zones 展示的域名所在的页码。
PageSize integer 示例值：10
每页包含的域名的数量。
请求示例
GET /?Action=ListPrivateZones&Version=2022-06-01&PageNumber=1&PageSize=10&ProjectName=default&ZIDs.N=234&VpcTrns=%5B%22trn%3Avpc%3Acn-beijing%3A12345678%3Avpc%2Fvpc-3reow******hxad79k%22%5D&SearchMode=LIKE&ZoneName=example.com&RecursionMode=true&LineMode=0&VpcID=vpc-123456&Region=cn-beijing&ZIDs=123 HTTP/1.1
Host: private-zone.volcengineapi.com
X-Date: 20260526T031845Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260526/cn-beijing/private_zone/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
返回示例
{
"ResponseMetadata": {
"RequestId": "202605261119121181042292234197AC",
"Action": "ListPrivateZones",
"Version": "2022-06-01",
"Service": "private_zone",
"Region": "cn-beijing"
},
"Result": {
"Total": 10,
"Zones": [
{
"CreatedAt": "2023-09-14T16:54:40+08:00",
"UpdatedAt": "2023-09-14T16:54:40+08:00",
"ZID": 1234,
"ZoneName": "example.com",
"Remark": "remark",
"RecordCount": 10,
"RecursionMode": true,
"LineMode": 0,
"LastOperator": "21xxxx1",
"Region": [
"华北1（北京）|cn-north-1"
],
"ProjectName": "default",
"Tags": [
{
"Key": "key",
"Value": "value"
}
]
}
],
"PageNumber": 1,
"PageSize": 10
}
}
错误码
最近更新时间：2026.05.26 11:23:45
这个页面对您有帮助吗？
有用
有用
无用
无用