All Products
Search
Document Center

Alibaba Cloud DNS:DescribeDnsCacheDomains

Last Updated:Oct 24, 2024

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
alidns:DescribeDnsCacheDomainsget
  • CacheDomain
    acs:alidns::{#accountId}:dnscache/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

The language.

zh
KeywordstringNo

The keyword for searches in "%KeyWord%" mode. The value is not case-sensitive.

a''
PageNumberlongNo

The page number. Pages start from page 1. Default value: 1.

1
PageSizelongNo

The number of entries per page. Maximum value: 100. Default value: 20.

20

Response parameters

ParameterTypeDescriptionExample
object
Domainsarray<object>

The domain names.

Domainobject
SourceProtocolstring

The origin protocol policy. Valid values: TCP and UDP. Default value: UDP.

UDP
UpdateTimestring

The time when the configurations of the domain name were updated. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.

2023-05-22T03:40Z
Remarkstring

The description of the domain name.

remark
ExpireTimestring

The time when the instance expires. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.

2022-12-02T16:00Z
CreateTimestring

The time when the domain name was added. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.

2022-10-17T06:13Z
InstanceIdstring

The instance ID of the cache-accelerated domain name.

i-7bg
SourceEdnsstring

Specifies whether the origin Domain Name System (DNS) server supports Extension Mechanisms for DNS (EDNS). Valid values: NOT_SUPPORT and SUPPORT.

SUPPORT
DomainNamestring

The cache-accelerated domain name.

dns-example.top
DomainIdstring

The ID of the cache-accelerated domain name.

00efd71a-770e-4255-b54e-6fe5659baffe
UpdateTimestamplong

The time when the configurations of the domain name were updated. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

1671690491000
ExpireTimestamplong

The time when the instance expires. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

1692374400000
CacheTtlMaxinteger

The maximum time-to-live (TTL) period of the cached data retrieved from the origin DNS server. Unit: seconds. Valid values: 30 to 86400.

86400
CacheTtlMininteger

The minimum TTL period of the cached data retrieved from the origin DNS server. Unit: seconds. Valid values: 30 to 86400.

30
VersionCodestring

The edition code of Alibaba Cloud DNS.

ultimate
SourceDnsServersarray<object>

The origin DNS servers.

SourceDnsServerobject
Hoststring

The domain name or IP address of the origin DNS server.

ns8.alidns.com
Portstring

The port of the origin DNS server.

53
CreateTimestamplong

The time when the domain name was added. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

1660546144000
TotalCountlong

The total number of entries returned.

3
PageSizelong

The number of entries per page. Valid values: 1 to 100. Default value: 20.

20
RequestIdstring

The request ID.

57121A9C-CDCF-541F-AD39-275D89099420
PageNumberlong

The page number. Pages start from page 1. Default value: 1.

1

Examples

Sample success responses

JSONformat

{
  "Domains": [
    {
      "SourceProtocol": "UDP",
      "UpdateTime": "2023-05-22T03:40Z",
      "Remark": "remark",
      "ExpireTime": "2022-12-02T16:00Z",
      "CreateTime": "2022-10-17T06:13Z",
      "InstanceId": "i-7bg",
      "SourceEdns": "SUPPORT",
      "DomainName": "dns-example.top",
      "DomainId": "00efd71a-770e-4255-b54e-6fe5659baffe",
      "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

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history