DescribeDnsCacheDomains - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries authoritative proxy domain names based on the specified parameters.

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

alidns:DescribeDnsCacheDomains

get

*CacheDomain

acs:alidns::{#accountId}:dnscache/*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the request and response. Valid values: zh: Chinese en: English The default value is zh.	zh
Keyword	string	No	The keyword. The search is performed in the `%Keyword%` format. The search is case-insensitive.	a
PageNumber	integer	No	The page number. The value starts from 1. The default value is 1.	1
PageSize	integer	No	The number of entries per page for paged queries. The maximum value is 100. The default value is 20.	20

Response elements

Element	Type	Description	Example
	object
Domains	array<object>	The list of domain names returned.
	object	The details of a domain name.
SourceProtocol	string	The origin protocol. Valid values: TCP and UDP. The default value is UDP.	UDP
UpdateTime	string	The time when the domain name was last updated.	2023-05-22T03:40Z
Remark	string	The remarks.	remark
ExpireTime	string	The expiration time of the instance.	2022-12-02T16:00Z
CreateTime	string	The time when the domain name was added.	2022-10-17T06:13Z
InstanceId	string	The ID of the authoritative proxy domain instance.	i-7***
SourceEdns	string	Indicates whether the origin server supports Extension Mechanisms for DNS (EDNS). Valid values: NOT_SUPPORT and SUPPORT.	SUPPORT
DomainName	string	The name of the authoritative proxy domain.	example.com
DomainId	string	The ID of the authoritative proxy domain.	00efd71a-770e-*****************
UpdateTimestamp	integer	The timestamp that indicates when the domain name was last updated.	1671690491000
ExpireTimestamp	integer	The timestamp that indicates when the instance expires.	1692374400000
CacheTtlMax	integer	The maximum Time to Live (TTL) for cached data retrieved from the origin server. The value ranges from 30 to 86400.	86400
CacheTtlMin	integer	The minimum TTL for cached data retrieved from the origin server. The value ranges from 30 to 86400.	30
VersionCode	string	The version code of Alibaba Cloud DNS.	ultimate
SourceDnsServers	array<object>	The list of origin DNS servers.
	object	An origin DNS server.
Host	string	The domain name or IP address of the origin server.	ns8.alidns.com
Port	string	The port of the origin DNS server.	53
CreateTimestamp	integer	The timestamp that indicates when the domain name was added.	1660546144000
TotalCount	integer	The total number of domain names.	3
PageSize	integer	The number of entries per page. The maximum value is 100. The default value is 20.	20
RequestId	string	The unique request ID.	57121A9C-CDCF-541F-AD39-275D89099420
PageNumber	integer	The page number. The value starts from 1. The default value is 1.	1

Examples

Success response

JSON format

{
  "Domains": [
    {
      "SourceProtocol": "UDP",
      "UpdateTime": "2023-05-22T03:40Z",
      "Remark": "remark",
      "ExpireTime": "2022-12-02T16:00Z",
      "CreateTime": "2022-10-17T06:13Z",
      "InstanceId": "i-7***",
      "SourceEdns": "SUPPORT",
      "DomainName": "example.com",
      "DomainId": "00efd71a-770e-*****************",
      "UpdateTimestamp": 1671690491000,
      "ExpireTimestamp": 1692374400000,
      "CacheTtlMax": 86400,
      "CacheTtlMin": 30,
      "VersionCode": "ultimate",
      "SourceDnsServers": [
        {
          "Host": "ns8.alidns.com",
          "Port": "53"
        }
      ],
      "CreateTimestamp": 1660546144000
    }
  ],
  "TotalCount": 3,
  "PageSize": 20,
  "RequestId": "57121A9C-CDCF-541F-AD39-275D89099420",
  "PageNumber": 1
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.