DescribeZones - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

You can call the DescribeZones operation to query a list of zones available to your account.

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

list

*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
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Maximum value: 100. Default value: 20.	20
Keyword	string	No	The keyword of the zone name. The search is not case-sensitive. You can set the SearchMode parameter to switch between exact search and fuzzy search. The default mode is fuzzy search.	test
SearchMode	string	No	The search mode. This parameter takes effect only when the Keyword parameter is specified. Valid values: LIKE: fuzzy search (default) EXACT: exact search Default value: LIKE.	EXACT
QueryRegionId	string	No	The region ID of the VPC that is associated with the zone.	cn-hangzhou
QueryVpcId	string	No	The ID of the VPC that is associated with the zone.	vpc-f8zvrvr1payllgz38****
ResourceGroupId	string	No	The ID of the resource group to which the zone belongs.	rg-aekz2qj7awz****
ZoneType	string	No	The type of the zones to query. Valid values: AUTH_ZONE: authoritative zones. CLOUD_PRODUCT_ZONE: zones for cloud services. Default value: AUTH_ZONE.	AUTH_ZONE
ZoneTag	array	No	The list of cloud service types.	BLINK
	string	No	The type of the cloud service. This parameter is ignored if you query authoritative zones. If you query PrivateZone zones for cloud services that you use or manage, the zones of the specified cloud service type are queried.	BLINK
ResourceTag	array<object>	No	The resource tags that are added to the zone.
	object	No
Key	string	No	The key of the resource tag.	env
Value	string	No	The value of the resource tag.	daily

Response elements

Element	Type	Description	Example
	object
PageSize	integer	The number of entries returned per page.	20
RequestId	string	The unique ID of the request.	6856BCF6-11D6-4D7E-AC53-FD579933522B
PageNumber	integer	The page number of the returned data.	1
TotalPages	integer	The total number of pages returned.	1
TotalItems	integer	The total number of entries returned.	1
Zones	object
Zone	array<object>	The list of zones.
	object	The details of a zone object.
UpdateTime	string	The time when the zone was last updated.	2018-01-03T08:57Z
ResourceTags	object
ResourceTag	array<object>	The list of resource tags that are added to the zone.
	object
Key	string	The key of the resource tag.	env
Value	string	The value of the resource tag.	daily
ZoneType	string	The type of the zone. Valid values: AUTH_ZONE: authoritative zone. CLOUD_PRODUCT_ZONE: PrivateZone for a cloud service.	AUTH_ZONE
Remark	string	The remarks on the zone.	test
CreateTime	string	The time when the zone was created.	2017-12-28T13:08Z
RecordCount	integer	The number of DNS records in the zone.	2
ZoneName	string	The name of the zone.	test.com
ProxyPattern	string	Indicates whether the recursive proxy feature is enabled for subdomains. Valid values: ZONE: The recursive proxy feature is disabled. When you resolve a subdomain that does not exist in the current zone, an NXDOMAIN error is returned. RECORD: The recursive proxy feature is enabled. When you resolve a subdomain that does not exist in the current zone, the system queries the forwarding and recursion modules and uses the final result to respond to the DNS request.	ZONE
UpdateTimestamp	integer	The time when the zone was last updated. This value is a UNIX timestamp.	1514969843000
ResourceGroupId	string	The ID of the resource group to which the zone belongs.	rg-aekz2qj7awz****
ZoneId	string	The unique ID of the zone.	6d83e3b31aa60ca4aaa7161f1b6baa95
ZoneTag	string	The type of the cloud service. 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. Valid values: 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.	1514466483000
DnsGroup	string	The built-in authoritative location zone. Valid values: NORMAL_ZONE: regular zone FAST_ZONE: fast zone	NORMAL_ZONE
Creator	string	The creator of the zone.	546356****
CreatorSubType	string	The type of the account. Valid values: CUSTOMER: Alibaba Cloud account SUB: RAM user STS: role assumption OTHER: other	SUB
DnsGroupChanging	boolean	The status of the zone migration. true: The zone is being migrated. false: The zone is not being migrated.	false
SlaveDnsStatus	string

Examples

Success response

JSON format

{
  "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,
        "SlaveDnsStatus": ""
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.