DescribeZoneInfo - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Call the DescribeZoneInfo operation to retrieve the details of a specified built-in authoritative zone. The details include the list of VPCs that are bound to the zone.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

pvtz:DescribeZoneInfo

get

*Zone

acs:pvtz::{#accountId}:zone/{#ZoneId}

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the response. Valid values: zh: Chinese. en: English. Default: en	en
ZoneId	string	Yes	The unique ID of the zone.	df2d03865266bd9842306db586d3****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique ID of the request.	F73F41A3-B6DD-42CA-A793-FFF93277835D
SlaveDns	boolean	Indicates whether secondary DNS is enabled. Valid values: true: Enabled false: Disabled	false
ResourceGroupId	string	The ID of the resource group to which the zone belongs.	rg-acfmykd63gt****
ZoneId	string	The unique ID of the zone.	df2d03865266bd9842306db586d3****
ProxyPattern	string	Indicates whether the recursive proxy for subdomains is enabled. ZONE: Disabled. If a non-existent subdomain is resolved, an NXDOMAIN response is returned to indicate that the subdomain does not exist. RECORD: Enabled. If a non-existent subdomain is resolved, the system queries the forwarding and recursion modules in sequence and uses the final result to respond to the DNS query.	ZONE
CreateTime	string	The time when the zone was created.	2024-07-15T09:40Z
ZoneType	string	The type of the zone. Valid values: AUTH_ZONE: Authoritative zone. CLOUD_PRODUCT_ZONE: Authoritative zone for a cloud product.	AUTH_ZONE
Remark	string	The remarks.	test
ZoneName	string	The name of the zone.	zone-test.cn
ZoneTag	string	The tag of the zone.	pvtz
UpdateTime	string	The time when the zone was last updated.	2024-07-22T09:39Z
UpdateTimestamp	integer	The timestamp that indicates when the zone was last updated.	1721641148000
RecordCount	integer	The total number of DNS records in the zone.	5
CreateTimestamp	integer	The timestamp that indicates when the zone was created.	1721036404000
BindVpcs	object
Vpc	array<object>	The list of bound VPCs.
	object	The list of bound VPCs.
VpcName	string	The name of the VPC.	vpc_test
VpcId	string	The unique ID of the VPC.	vpc-f8zvrvr1payllgz38****
VpcType	string	The type of the VPC. Valid values: STANDARD: Standard VPC. EDS: Elastic Desktop Service (EDS) workspace VPC.	STANDARD
RegionName	string	The name of the region where the VPC is located.	China (Heyuan)
VpcUserId	integer	The ID of the user to which the VPC belongs. If this parameter is null, the VPC belongs to the current user.	141339776561****
RegionId	string	The ID of the region where the VPC is located.	cn-heyuan
IsPtr	boolean	Indicates whether the zone is a reverse lookup zone. Valid values: true: The zone is a reverse lookup zone. false: The zone is not a reverse lookup zone.	false
DnsGroup	string	The DNS group. Valid values: NORMAL_ZONE: Regular group FAST_ZONE: Fast group	FAST_ZONE
Creator	string	The creator of the zone.	141339776561****
CreatorType	string	The type of the creator.	USER
DnsGroupChanging	boolean	The status of switching the DNS group for the zone. You can switch a zone between the regular and fast groups. Valid values: true: The DNS group is being switched. false: The DNS group is not being switched.	false
BindEdgeDnsClusters	object
EdgeDnsCluster	array<object>
	object
ClusterId	string
ClusterName	string
ClusterUserId	integer

Examples

Success response

JSON format

{
  "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,
  "BindEdgeDnsClusters": {
    "EdgeDnsCluster": [
      {
        "ClusterId": "",
        "ClusterName": "",
        "ClusterUserId": 0
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The specified value parameter is not valid.
400	IllegalUser	The user is illegal.
400	Zone.Invalid.Name	Zone name is invalid.
400	Zone.Invalid.Id	Zone id is invalid.	Zone id is invalid.
400	Zone.Invalid.UserId	Zone userid is invalid.
400	Zone.NotExists	Zone is not exists
400	Zone.VpcExists	Zone have vpc bound.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.