You need to enable JavaScript to run this app.
导航

获取域名列表

最近更新时间2023.12.15 10:24:13

首次发布时间2023.02.08 13:11:36

API 说明

API 名称:ListPrivateZones
API 域名:open.volcengineapi.com
API 描述:获取一个或多个域名。

请求方法

GET

请求参数

除了以下参数,您还需要在请求头中指定 请求方法 并包含 签名参数

参数名称
数据类型参数类型是否必选参数说明
ActionString查询参数API 的名称。该参数的取值是 ListPrivateZones
VersionString查询参数API 的版本。该参数的取值是 2022-06-01
PageNumberInteger查询参数页码。页数由获取的域名总数和 PageSize 确定。
默认为 1。

PageSize

Integer

查询参数

每页包含的域名的数量。
默认为 10。最大值为 200。
返回结果会将获取的域名进行分页显示。页数由获取的域名总数和 PageSize 确定。

SearchMode

String

查询参数

查询模式。包括以下模式:

  • LIKE:模糊查询。例如 %key%
  • EXACT:精确查询。例如 key


默认为模糊查询。

ZoneNameString查询参数查询域名使用的关键字,例如 example.com
RecursionModeBoolean查询参数域名是否开启了递归解析。
  • true:域名开启了递归解析。
  • false:域名未开启递归解析。
LineModeInteger查询参数域名是否开启了智能解析和负载均衡。
  • 0:域名关闭了智能解析和负载均衡。
  • 1:域名开启了负载均衡,同时关闭了智能解析。
  • 2:域名关闭了负载均衡,同时开启了智能解析。
  • 3:域名开启了智能解析和负载均衡。
VpcIDString查询参数关联该域名的 VPC ID。
RegionString查询参数域名生效的地域。
ZIDsInteger查询参数域名 ID。您可以输入一个或多个域名 ID,例如 ZIDs=1234567&ZIDs=2345678

响应正文

参数名称
数据类型
参数说明
ResponseMetadata
Object
响应的元数据。
Result
Object
返回结果。

示例

请求示例

GET https://open.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"
                ]
            }
        ],
        "Total": 402,
        "PageNumber": 1,
        "PageSize": 1
    }
}