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

文档中心

立即注册

TrafficRoute DNS 套件

域名管理

ListZones - 获取域名列表

获取域名的列表。

使用说明

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

请求说明

请求方式：GET
请求地址：https://dns.volcengineapi.com/?Action=ListZones&Version=2018-08-01

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	ListZones	要执行的操作，取值：ListZones。
Version	String	是	2018-08-01	API的版本，取值：2018-08-01。
ProjectName	String	否	default	域名的项目。如果您不设置该参数，该 API 不会根据该参数筛选查询结果。
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"`。如果您指定多个标签键，云解析 DNS 会查询同时包含所有指定标签键的域名。标签值：例如 `"Values":["v1", "v2"]`。标签值数组的长度取值范围为 1～3。您可不传入 `Values`，表示查询时 `Values` 不作为查询条件。如果您把仅包含空字符串的数组传入 `Values` ，云解析 DNS 会查询 `Values` 为空的标签。如果一个 `Values` 包含多个值，这些值之间的关系为逻辑或（OR）。如果您不设置该参数，该 API 不会根据该参数筛选查询结果。
PageNumber	Integer	否	1	页码。API 返回该页码所包含的域名。该参数的默认值是 1。
PageSize	Integer	否	10	每页包含的域名数量。系统会将获取的域名进行分页显示。页数是由获取的域名总数和 PageSize 确定。该参数的默认值是 10，最大值是 500。
Key	String	否	example	获取包含特定关键字的域名。
OrderKey	String	否	ZoneName	结果排序的键值。该参数有以下取值： `ZoneName`：按域名排序。 `Remark`：按域名的备注排序。 `TradeCode`：按域名的功能版本排序。 `UpdatedAt`：（默认）按域名最近一次的更新时间排序。 `ExpiredTime`：按域名的过期时间排序。免费版的域名不会过期。 `Stage`：按域名的状态排序。 `RecordCount`：按域名的记录值数量排序。
SearchMode	String	否	like	表示 `Key` 的匹配模式。该参数有以下取值： `like`：表示模糊匹配。 `exact`：表示精确匹配。该参数的默认值是 `like`。
SearchOrder	String	否	asc	结果的排序方式。该参数有以下取值： `asc`：升序。 `desc`：（默认）降序。
Stage	String	否	0	域名的状态。如果您不设置该参数，该 API 不会根据该参数筛选查询结果。该参数有以下取值： `0`：正常。 `1`：域名待找回。 `2`：未使用TrafficRoute解析。 `3`：异常。 `5`：请变更DNS服务器
TradeCode	String	否	free_inner	域名的功能版本。如果您不设置该参数，该 API 不会根据该参数筛选查询结果。 `free_inner`：免费版。 `professional_inner`：专业版。 `enterprise_inner`：企业版。 `ultimate_inner`：旗舰版。 `ultimate_exclusive_inner`：尊享版。

返回参数

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

参数	类型	示例值	描述
Total	Integer	2	表示获取到的域名数量。
Zones	Array of Object	无	获取的域名列表。

请求示例

GET /?Action=ListZones&Version=2018-08-01 HTTP/1.1
Host: dns.volcengineapi.com
X-Date: 20240831T122850Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240831/cn-beijing/dns/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240831202859182083212171D44B83",
    "Action": "ListZones",
    "Version": "2018-08-01",
    "Service": "dns",
    "Region": "cn-beijing"
  },
  "Result": {
    "Total": 2,
    "Zones": [
            {
                "CreatedAt": "2022-11-01T10:20:03+08:00",
                "UpdatedAt": "2022-11-01T10:20:03+08:00",
                "ZID": 2636,
                "ZoneName": "example.com",
                "InstanceID": null,
                "Remark": "",
                "ConfigurationCode": "free",
                "RecordCount": 0,
                "ExpiredTime": 0,
                "LastOperator": "2100098272",
                "CacheStage": 0,
                "TradeCode": "free_inner",
                "DnsSecurity": "",
                "IsSubDomain": false,
                "ProjectName": "default",
                "Tags": []
            },
            {
                "CreatedAt": "2022-01-28T16:46:08+08:00",
                "UpdatedAt": "2022-10-31T14:22:05+08:00",
                "ZID": 1376,
                "ZoneName": "test.com",
                "InstanceID": null,
                "Remark": "update2",
                "ConfigurationCode": "free",
                "RecordCount": 4,
                "ExpiredTime": 0,
                "LastOperator": "2100098272",
                "CacheStage": 0,
                "TradeCode": "free_inner",
                "DnsSecurity": "",
                "IsSubDomain": false,
                "ProjectName": "default",
                "Tags": []
            }
        ]
  }
}

错误码

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

状态码	错误码	错误信息	说明
400	ErrParsingParams	parsing params error	解析请求失败。
400	ErrParamInvalid	validation fail:%s	参数校验失败。
500	ErrInternalServer	server internal error	服务内部错误。

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

这个页面对您有帮助吗？

有用

无用

TrafficRoute DNS 套件

使用说明 #

请求说明 #

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #