You need to enable JavaScript to run this app.
导航
TrafficRoute DNS 套件
  • 文档首页
    • /
  • TrafficRoute DNS 套件

获取域名列表

最近更新时间：2023.12.06 10:39:30

首次发布时间：2022.11.24 20:57:30

我的收藏

API 说明

API 名称：ListZones。
API 域名：open.volcengineapi.com。
API 描述：获取域名的列表。

请求方法

GET

调用限制

每秒最多调用 20 次。

请求参数

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

参数名称
数据类型参数类型是否必选参数说明
ActionString查询参数是API 的名称。该参数的取值是 ListZones。
VersionString查询参数是API 的版本。该参数的取值是 2018-08-01。

PageSize

Integer

查询参数

否

每页包含的域名数量。

系统会将获取的域名进行分页显示。页数是由获取的域名总数和 PageSize 确定。

该参数的默认值是 10，最大值是 500。

PageNumberInteger查询参数否页码。API 返回该页码所包含的域名。该参数的默认值是 1。
KeyString查询参数否获取包含特定关键字的域名。

SearchMode

String

查询参数

否

表示 Key 的匹配模式。该参数有以下取值：

  • like：表示模糊匹配。

  • exact：表示精确匹配。

该参数的默认值是 like。

RemarkString查询参数否域名的备注。如果您不设置该参数，该 API 不会根据该参数筛选查询结果。

TradeCode

String

查询参数

否

域名的功能版本。如果您不设置该参数，该 API 不会根据该参数筛选查询结果。

  • free_inner：免费版。

  • professional_inner：专业版。

  • enterprise_inner：企业版。

  • ultimate_inner：旗舰版。

  • ultimate_exclusive_inner：尊享版。

AboutToExpire

Boolean

查询参数

否

域名是否即将到期。如果您不设置该参数，该 API 不会根据该参数筛选查询结果。该参数有以下取值：

  • true：域名距离到期日还有 15 天或不足 15 天。
  • false：域名距离到期日大于 15 天。

Stage

Integer

查询参数

否

域名的状态。如果您不设置该参数，该 API 不会根据该参数筛选查询结果。该参数有以下取值：

  • 0：正常。
  • 1：域名待找回。
  • 2：未使用TrafficRoute解析。
  • 3：异常。
  • 5：请变更DNS服务器。

SearchOrder

String

查询参数

否

结果的排序方式。该参数有以下取值：

  • asc：升序。
  • dsc：（默认）降序。

OrderKey

String

查询参数

否

结果排序的键值。该参数有以下取值：

  • ZoneName：按域名排序。
  • Remark：按域名的备注排序。
  • TradeCode：按域名的功能版本排序。
  • UpdatedAt：（默认）按域名最近一次的更新时间排序。
  • ExpiredTime：按域名的过期时间排序。免费版的域名不会过期。
  • Stage：按域名的状态排序。
  • RecordCount：按域名的记录值数量排序。

响应正文

ResponseMetadata 对象

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

Result 对象

参数名称
数据类型
参数说明
Total
Integer
表示获取到的域名数量。
Zones
Array of Objects
获取的域名列表。

示例

请求示例

GET https://open.volcengineapi.com?Version=2018-08-01&Action=ListZones&SearchMode=exact

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20221101140124010212145227005B7261",
        "Action": "ListZones",
        "Version": "2018-08-01",
        "Service": "dns",
        "Region": "cn-north-1"
    },
    "Result": {
        "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": ""
            },
            {
                "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": ""
            }
        ],
        "Total": 2
    }
}