最近更新时间:2023.12.15 10:24:13
首次发布时间:2023.02.08 13:11:36
API 名称:ListPrivateZones
。
API 域名:open.volcengineapi.com
。
API 描述:获取一个或多个域名。
GET
除了以下参数,您还需要在请求头中指定 请求方法 并包含 签名参数。
参数名称 | 数据类型 | 参数类型 | 是否必选 | 参数说明 |
---|---|---|---|---|
Action | String | 查询参数 | 是 | API 的名称。该参数的取值是 ListPrivateZones 。 |
Version | String | 查询参数 | 是 | API 的版本。该参数的取值是 2022-06-01 。 |
PageNumber | Integer | 查询参数 | 否 | 页码。页数由获取的域名总数和 PageSize 确定。默认为 1。 |
PageSize | Integer | 查询参数 | 否 | 每页包含的域名的数量。 |
SearchMode | String | 查询参数 | 否 | 查询模式。包括以下模式:
默认为模糊查询。 |
ZoneName | String | 查询参数 | 否 | 查询域名使用的关键字,例如 example.com 。 |
RecursionMode | Boolean | 查询参数 | 否 | 域名是否开启了递归解析。
|
LineMode | Integer | 查询参数 | 否 | 域名是否开启了智能解析和负载均衡。
|
VpcID | String | 查询参数 | 否 | 关联该域名的 VPC ID。 |
Region | String | 查询参数 | 否 | 域名生效的地域。 |
ZIDs | Integer | 查询参数 | 否 | 域名 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 } }