DescribeZones - 获取 zone 列表

调用DescribeZones查询当前用户的Zone列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
pvtz:DescribeZones
*Zone
acs:pvtz::{#accountId}:zone/*

请求参数

名称类型必填描述示例值
Langstring

返回值语言,取值:

  • zh:中文。

  • en:英文。

默认值:en

en
PageNumberinteger

分页查询时设置查询的页码,起始值为 1,默认为 1。

1
PageSizeinteger

分页查询时设置的每页行数,最大值 100,默认为 20

20
Keywordstring

Zone 名称关键字,不区分大小写。你可通过设置搜索模式(SearchMode)切换为“精确搜索”或“模糊搜索”,默认为“模糊搜索”。

test
SearchModestring

搜索模式(作用于 Keyword 参数)。取值:

  • LIKE:模糊搜索(默认)
  • EXACT:精确搜索

默认值:LIKE

EXACT
QueryRegionIdstring

Zone 关联 VPC 所属的地域 ID。

cn-hangzhou
QueryVpcIdstring

与 zone 关联的 VPC ID。

vpc-f8zvrvr1payllgz38****
ResourceGroupIdstring

zone 所属的资源组 ID。

rg-aekz2qj7awz****
ZoneTypestring

Zone 查询类型。取值:

  • AUTH_ZONE: 查权威 Zone 列表。
  • CLOUD_PRODUCT_ZONE:使用的云产品 Zone 列表。

默认: AUTH_ZONE

AUTH_ZONE
ZoneTagarray

云产品类型列表。

string

云产品类型。

  • 若查询权威 Zone 列表,则忽略此参数;
  • 若查询使用或者管理的云产品 PrivateZone,则查询对应的云产品类型 Zone 列表。
BLINK
ResourceTagarray<object>

与 zone 关联的资源标签。

object
Keystring

资源标签键。

env
Valuestring

资源标签值。

daily

返回参数

名称类型描述示例值
object
PageSizeinteger

返回的每页数据量。

20
RequestIdstring

唯一请求识别码。

6856BCF6-11D6-4D7E-AC53-FD579933522B
PageNumberinteger

返回数据的当前页码。

1
TotalPagesinteger

全部数据的总页数。

1
TotalItemsinteger

全部数据的总个数。

1
Zonesarray<object>

zone 列表。

Zoneobject

zone 对象详情。

UpdateTimestring

更新时间。

2018-01-03T08:57Z
ResourceTagsarray<object>

zone 关联的资源标签列表。

ResourceTagobject
Keystring

资源标签键。

env
Valuestring

资源标签值。

daily
ZoneTypestring

Zone 类型。说明:

  • AUTH_ZONE: 权威 Zone。
  • CLOUD_PRODUCT_ZONE: 云产品 PrivateZone。
AUTH_ZONE
Remarkstring

zone 的备注信息。

test
CreateTimestring

创建时间。

2017-12-28T13:08Z
RecordCountinteger

zone 解析记录数量。

2
ZoneNamestring

zone 名称。

test.com
ProxyPatternstring

是否开启子域名递归代理。说明:

  • ZONE: 关闭(当解析本域名下不存在的子域名时,直接返回 NXDOMAIN,表示子域名不存在)
  • RECORD: 开启(当解析本域名下不存在的子域名时,会依次查询“转发”和“递归”模块,并以最终查询到的解析结果来应答解析请求)
ZONE
UpdateTimestamplong

更新时间(时间戳)。

1514969843000
ResourceGroupIdstring

zone 所属资源组 ID。

rg-aekz2qj7awz****
ZoneIdstring

Zone ID,Zone 的唯一识别码。

6d83e3b31aa60ca4aaa7161f1b6baa95
ZoneTagstring

云产品类型。

  • 若 ZoneType 为权威 zone,则此为空;
  • 若 ZoneType 为云产品 zone,则此为云产品类型。
BLINK
IsPtrboolean

是否为反解 zone。说明:

  • true:是反解 zone
  • false:非反解 zone
false
CreateTimestamplong

创建时间(时间戳)。

1514466483000
DnsGroupstring

内置权威位置区。说明:

  • NORMAL_ZONE:普通区
  • FAST_ZONE:快速区
NORMAL_ZONE
Creatorstring

zone 创建者。

546356****
CreatorSubTypestring

账号类型。说明:

  • CUSTOMER:主账号
  • SUB:子账号
  • STS:角色扮演
  • OTHER:其他
SUB
DnsGroupChangingboolean

Zone 切换位置区状态。

  • true:切换中
  • false:未切换
false

示例

正常返回示例

JSON格式

{
  "PageSize": 20,
  "RequestId": "6856BCF6-11D6-4D7E-AC53-FD579933522B",
  "PageNumber": 1,
  "TotalPages": 1,
  "TotalItems": 1,
  "Zones": {
    "Zone": [
      {
        "UpdateTime": "2018-01-03T08:57Z",
        "ResourceTags": {
          "ResourceTag": [
            {
              "Key": "env",
              "Value": "daily"
            }
          ]
        },
        "ZoneType": "AUTH_ZONE",
        "Remark": "test",
        "CreateTime": "2017-12-28T13:08Z",
        "RecordCount": 2,
        "ZoneName": "test.com",
        "ProxyPattern": "ZONE",
        "UpdateTimestamp": 1514969843000,
        "ResourceGroupId": "rg-aekz2qj7awz****",
        "ZoneId": "6d83e3b31aa60ca4aaa7161f1b6baa95",
        "ZoneTag": "BLINK",
        "IsPtr": false,
        "CreateTimestamp": 1514466483000,
        "DnsGroup": "NORMAL_ZONE",
        "Creator": "546356****",
        "CreatorSubType": "SUB",
        "DnsGroupChanging": false
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。