文档

DescribeZones - 获取 zone 列表

更新时间:

查询用户的Zone列表。

调试

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

授权信息

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

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

请求参数

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

语言。

en
PageNumberinteger

当前页数,起始值为 1,默认为 1。

1
PageSizeinteger

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

20
Keywordstring

zone 名称关键字,按照“%KeyWord%”模式搜索,不区分大小写。

test
SearchModestring

搜索模式。取值:

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

所属地域 ID。

cn-hangzhou
QueryVpcIdstring

VPC ID。

vpc-xxxxx
ResourceGroupIdstring

资源组 ID。

rg-xxxxx
ZoneTypestring

Zone 查询类型;默认取值 AUTH_ZONE,查权威 Zone 列表。

取值范围:

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

云产品类型。

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

资源标签。

Keystring

资源标签键。

env
Valuestring

资源标签值。

daily

返回参数

名称类型描述示例值
object
PageSizeinteger

页面大小。

20
RequestIdstring

请求 ID。

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

页码。

1
TotalPagesinteger

总页数。

3
TotalItemsinteger

总个数。

27
Zonesobject []

zone 列表。

UpdateTimestring

更新时间。

2018-01-03T08:57Z
ResourceTagsobject []

资源标签列表。

Keystring

资源标签键。

env
Valuestring

资源标签值。

daily
ZoneTypestring

Zone 类型。

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

zone 备注信息。

test
CreateTimestring

创建时间。

2017-12-28T13:08Z
RecordCountinteger

解析记录数。

2
ZoneNamestring

zone 名称。

test.com
ProxyPatternstring

递归解析代理模式。

  • ZONE: 全部劫持
  • RECORD:开启递归解析代理
ZONE
UpdateTimestamplong

更新时间(时间戳)。

1514969843000
ResourceGroupIdstring

资源组 ID。

rg-xxxxx
ZoneIdstring

zone ID。

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 创建者

5463564356
CreatorSubTypestring

账号类型。

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

Zone 切换位置区状态。

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

示例

正常返回示例

JSON格式

{
  "PageSize": 20,
  "RequestId": "6856BCF6-11D6-4D7E-AC53-FD579933522B",
  "PageNumber": 1,
  "TotalPages": 3,
  "TotalItems": 27,
  "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-xxxxx",
        "ZoneId": "6d83e3b31aa60ca4aaa7161f1b6baa95",
        "ZoneTag": "BLINK",
        "IsPtr": false,
        "CreateTimestamp": 1514466483000,
        "DnsGroup": "NORMAL_ZONE",
        "Creator": "5463564356",
        "CreatorSubType": "SUB",
        "DnsGroupChanging": false
      }
    ]
  }
}

错误码

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

  • 本页导读 (0)