DescribeZoneInfo - 获取zone详细信息

调用DescribeZoneInfo获取指定内置权威域名(Zone)的详细信息,包括当前Zone绑定的VPC列表信息等。

调试

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

授权信息

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

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

请求参数

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

返回值语言,取值:

  • zh:中文。

  • en:英文。

默认:en

en
ZoneIdstring

Zone ID,Zone 的唯一识别码。

df2d03865266bd9842306db586d3****

返回参数

名称类型描述示例值
object
RequestIdstring

唯一请求识别码。

F73F41A3-B6DD-42CA-A793-FFF93277835D
SlaveDnsboolean

是否开启辅助 DNS。取值:

  • true:已开启
  • false:未开启
false
ResourceGroupIdstring

当前 Zone 所属的资源组 ID。

rg-acfmykd63gt****
ZoneIdstring

Zone ID,Zone 的唯一识别码。

df2d03865266bd9842306db586d3****
ProxyPatternstring

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

  • ZONE: 关闭(当解析本域名下不存在的子域名时,直接返回 NXDOMAIN,表示子域名不存在)

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

ZONE
CreateTimestring

创建时间。

2024-07-15T09:40Z
ZoneTypestring

Zone 类型。说明:

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

备注信息。

test
ZoneNamestring

Zone 名称。

zone-test.cn
ZoneTagstring

Zone 标签。

pvtz
UpdateTimestring

更新时间。

2024-07-22T09:39Z
UpdateTimestamplong

更新时间(时间戳)。

1721641148000
RecordCountinteger

当前 Zone 设置的解析记录总数。

5
CreateTimestamplong

创建时间(时间戳)。

1721036404000
BindVpcsarray<object>

绑定的 Vpc 列表。

Vpcobject

绑定的 Vpc 列表。

VpcNamestring

专有网络(Vpc)名称。

vpc_test
VpcIdstring

Vpc ID,专有网络唯一标识。

vpc-f8zvrvr1payllgz38****
VpcTypestring

专有网络(vpc)类型。说明:

  • STANDARD:标准 VPC。

  • EDS:无影工作区 VPC。

STANDARD
RegionNamestring

专有网络(vpc)所属地域名称。

China (Heyuan)
VpcUserIdlong

专有网络(vpc)归属的用户 Id;若为 null 则归属当前用户。

141339776561****
RegionIdstring

专有网络(vpc)所属地域 ID。

cn-heyuan
IsPtrboolean

是否反解 zone。说明:

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

内置权威位置区。说明:

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

Zone 创建者。

141339776561****
CreatorTypestring

创建者类型。

USER
DnsGroupChangingboolean

Zone 切换位置区状态(普通区和快速区切换)。说明:

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

示例

正常返回示例

JSON格式

{
  "RequestId": "F73F41A3-B6DD-42CA-A793-FFF93277835D",
  "SlaveDns": false,
  "ResourceGroupId": "rg-acfmykd63gt****",
  "ZoneId": "df2d03865266bd9842306db586d3****",
  "ProxyPattern": "ZONE",
  "CreateTime": "2024-07-15T09:40Z",
  "ZoneType": "AUTH_ZONE",
  "Remark": "test",
  "ZoneName": "zone-test.cn",
  "ZoneTag": "pvtz",
  "UpdateTime": "2024-07-22T09:39Z",
  "UpdateTimestamp": 1721641148000,
  "RecordCount": 5,
  "CreateTimestamp": 1721036404000,
  "BindVpcs": {
    "Vpc": [
      {
        "VpcName": "vpc_test",
        "VpcId": "vpc-f8zvrvr1payllgz38****",
        "VpcType": "STANDARD",
        "RegionName": "China (Heyuan)",
        "VpcUserId": 0,
        "RegionId": "cn-heyuan"
      }
    ]
  },
  "IsPtr": false,
  "DnsGroup": "FAST_ZONE",
  "Creator": "141339776561****",
  "CreatorType": "USER",
  "DnsGroupChanging": false
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameterThe specified value parameter is not valid.-
400IllegalUserThe user is illegal.-
400Zone.Invalid.NameZone name is invalid.-
400Zone.Invalid.IdZone id is invalid.ZoneID不正确
400Zone.Invalid.UserIdZone userid is invalid.-
400Zone.NotExistsZone is not exists-
400Zone.VpcExistsZone have vpc bound.-

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