Recursive DNS Zone Resolution Overview - Alibaba Cloud DNS - Alibaba Cloud - Alibaba Cloud DNS

Searches for zones of built-in authoritative domain names used for recursive resolution.

Operation description

To retrieve resources, you must specify at least ResourceId.N or Tag.N (Tag.N.Key and Tag.N.Value) in the request.
Tag.N is a resource tag that consists of a key-value pair. If you specify only Tag.N.Key, all tag values associated with that key are returned. If you specify only Tag.N.Value, an error is returned.
If you specify both Tag.N and ResourceId.N, the operation returns only the resources that are identified by ResourceId.N and match all the specified tag key-value pairs.
If you specify multiple tag key-value pairs, only resources that match all of them are returned.

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

pubdns:SearchRecursionZones

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ZoneName	string	No	The name of the zone.	cheng.suow.cc
Remark	string	No	The remark for the zone. Fuzzy search is supported.	test
PageNumber	integer	Yes	The page number. Pages start at 1. Default value: 1.	1
PageSize	integer	Yes	The number of entries to return per page. Valid values: 1 to 100. Default value: 20.	5
EffectiveScopes	array<object>	No	The list of effective scopes.
	object	No	The effective scope for a built-in authoritative zone.
EffectiveType	string	No	The type of the effective scope. Valid value: `account`.	account
Scope	array	No	A list of scope values that correspond to the specified `EffectiveType`. For example, if `EffectiveType` is set to `account`, this parameter contains a list of account IDs for users that use recursive resolution.	[20003]
	string	No	An account ID.	20003
OrderBy	string	No	The sort field. Valid values: `UpdateTime`: the update time of the zone. `RecordCount`: the number of DNS records.	default
Direction	string	No	The sort order. Valid values: `asc`: ascending. `desc`: descending.	asc
MaxResults	integer	No	The maximum number of entries to return. Valid values: 1 to 100. Default value: 20.	50
NextToken	string	No	The token to retrieve the next page of results.	4698691

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	536E9CAD-DB30-4647-AC87-AA5CC38C5382
PageNumber	integer	The page number. Pages start from 1. The default is 1.	1
PageSize	integer	The number of items returned on each page.	20
TotalPages	integer	The total number of pages.	123
TotalItems	integer	The total number of items.	11
Zones	object
Zone	array<object>	The list of zones.
	array<object>	The details of a zone in the list.
ZoneId	string	The unique ID of the zone.	169439170000011
CreateTime	string	The time the zone was created.	2022-10-17T06:13Z
CreateTimestamp	integer	The creation timestamp.	1749694625000
UpdateTime	string	The time the zone was last modified.	2024-08-13T01:44Z
UpdateTimestamp	integer	The last modification timestamp.	1639621006000
ZoneName	string	The name of the zone.	ixiqiu.cn
Remark	string	The remark for the zone.	107
RecordCount	integer	The number of DNS records in the zone.	20
ProxyPattern	string	Indicates whether the recursive proxy for subdomains is enabled. Valid values: `zone`: Disabled. For queries to non-existent subdomains, the system returns an NXDOMAIN response. `record`: Enabled. For queries to non-existent subdomains, the system sequentially queries the forwarding and recursion modules and returns the final result.	record
Creator	string	The ID of the creator.	***
CreatorType	string	The type of the creator. Valid values are `USER` (a user) and `SYSTEM` (the system).	USER
CreatorSubType	string	The creator's account type. `CUSTOMER`: Alibaba Cloud account, `SUB`: RAM user, `STS`: assumed role, `OTHER`: other.	SUB
EffectiveScopes	object
EffectiveScope	array<object>	The resolution scope.
	array<object>
EffectiveType	string	The type of the effective scope. Valid value: `account`.	account
Scopes	object
Scope	array	The scope values. The meaning of these values depends on the `EffectiveType`. If `EffectiveType` is `account`, this parameter lists the account IDs of users who use recursive resolution.	[20003]
	string	An account ID.	20003
MaxResults	integer	The maximum number of items to return for this request.	20
NextToken	string	A pagination token used to retrieve the next page of results.	4698691

Examples

Success response

JSON format

{
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalPages": 123,
  "TotalItems": 11,
  "Zones": {
    "Zone": [
      {
        "ZoneId": "169439170000011",
        "CreateTime": "2022-10-17T06:13Z",
        "CreateTimestamp": 1749694625000,
        "UpdateTime": "2024-08-13T01:44Z",
        "UpdateTimestamp": 1639621006000,
        "ZoneName": "ixiqiu.cn",
        "Remark": "107",
        "RecordCount": 20,
        "ProxyPattern": "record",
        "Creator": "***",
        "CreatorType": "USER",
        "CreatorSubType": "SUB",
        "EffectiveScopes": {
          "EffectiveScope": [
            {
              "EffectiveType": "account",
              "Scopes": {
                "Scope": [
                  "20003"
                ]
              }
            }
          ]
        }
      }
    ]
  },
  "MaxResults": 20,
  "NextToken": "4698691"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.