DescribeZoneVpcTree - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Call the DescribeZoneVpcTree operation to query the zones and the Virtual Private Clouds (VPCs) attached to them in your account.

Operation description

This operation is not recommended due to low performance. To retrieve a list of zones, call DescribeZones. To retrieve the details of attached VPCs, call DescribeZoneInfo with the zone ID.

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:DescribeZoneVpcTree

*Zone

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

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the response. Valid values: zh: Chinese. en: English. Default value: en	en
UserClientIp	string	No	The IP address of the client.	127.0.XX.XX

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique ID of the request.	7B07FBC3-3A53-4939-A3C6-2BDFE407BAB2
Zones	object
Zone	array<object>	A list of zones.
	object	The details of the zone.
UpdateTime	string	The time when the zone was last updated.	2019-09-18T08:20Z
ZoneType	string	The type of the zone. Description: AUTH_ZONE: authoritative zone. CLOUD_PRODUCT_ZONE: authoritative zone for a cloud service.	AUTH_ZONE
Remark	string	The remarks.	demo
CreateTime	string	The time when the zone was created.	2019-09-18T08:20Z
Vpcs	object
Vpc	array<object>	A list of attached VPCs.
	object	The VPC information.
VpcName	string	The name of the VPC.	demo-vpc
VpcId	string	The unique ID of the VPC.	vpc-f8zvrvr1payllgz38****
VpcType	string	The type of the VPC. Description: STANDARD: standard VPC. EDS: Elastic Desktop Service (EDS) VPC.	STANDARD
RegionName	string	The name of the region where the VPC is located.	China (Heyuan)
RegionId	string	The ID of the region where the VPC is located.	cn-heyuan
RecordCount	integer	The number of DNS records in the zone.	1
ZoneName	string	The name of the zone.	example.com
UpdateTimestamp	integer	The time when the zone was last updated. This value is a UNIX timestamp.	1568794834000
ZoneId	string	The unique ID of the zone.	df2d03865266bd9842306db586d3****
ZoneTag	string	The type of the cloud service. Note This parameter is empty if ZoneType is set to AUTH_ZONE. This parameter indicates the type of the cloud service if ZoneType is set to CLOUD_PRODUCT_ZONE.	BLINK
IsPtr	boolean	Indicates whether the zone is a reverse lookup zone. Description: true: The zone is a reverse lookup zone. false: The zone is not a reverse lookup zone.	false
CreateTimestamp	integer	The time when the zone was created. This value is a UNIX timestamp.	1568794812000
DnsGroup	string	The built-in authoritative zone. Description: NORMAL_ZONE: regular zone. FAST_ZONE: fast zone.	NORMAL_ZONE
Creator	string	The creator of the zone.	141339776561****
CreatorType	string	The type of the operator.	USER
DnsGroupChanging	boolean	The status of switching the zone location between a regular zone and a fast zone. Description: true: The zone is being switched. false: The zone is not being switched.	true

Examples

Success response

JSON format

{
  "RequestId": "7B07FBC3-3A53-4939-A3C6-2BDFE407BAB2",
  "Zones": {
    "Zone": [
      {
        "UpdateTime": "2019-09-18T08:20Z",
        "ZoneType": "AUTH_ZONE",
        "Remark": "demo",
        "CreateTime": "2019-09-18T08:20Z",
        "Vpcs": {
          "Vpc": [
            {
              "VpcName": "demo-vpc",
              "VpcId": "vpc-f8zvrvr1payllgz38****",
              "VpcType": "STANDARD",
              "RegionName": "China (Heyuan)",
              "RegionId": "cn-heyuan"
            }
          ]
        },
        "RecordCount": 1,
        "ZoneName": "example.com\n",
        "UpdateTimestamp": 1568794834000,
        "ZoneId": "df2d03865266bd9842306db586d3****",
        "ZoneTag": "BLINK",
        "IsPtr": false,
        "CreateTimestamp": 1568794812000,
        "DnsGroup": "NORMAL_ZONE",
        "Creator": "141339776561****",
        "CreatorType": "USER",
        "DnsGroupChanging": true
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.