All Products
Search
Document Center

Alibaba Cloud DNS:DescribeDomainStatisticsSummary

Last Updated:Apr 10, 2024

Calls the DescribeDomainStatisticsSummary operation to obtain the query volume of all paid domain names under your account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:DescribeDomainStatisticsSummaryREAD
  • Domain
    acs:alidns::{#accountId}:domain/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

The language type.

en
PageNumberlongYes

The number of the page to return. Pages start from page 1. Default value: 1.

1
PageSizelongNo

The number of entries to return on each page. Maximum value: 100. Minimum value: 1. Default value: 20.

20
StartDatestringYes

The beginning of the time range to query. Specify the time in the YYYY-MM-DD format.

You can only query DNS records of the last 90 days.

2019-07-04
EndDatestringNo

The end of the time range to query. Specify the time in the YYYY-MM-DD format.

The default value is the day when you perform the operation.

2019-07-04
SearchModestringNo

The search mode of the keyword. Valid values:

  • LIKE: fuzzy match (default).
  • EXACT: exact match.
LIKE
KeywordstringNo

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

test
ThresholdlongNo

The threshold of query volume that can be obtained. You can also obtain data about a domain name with the query volume less than or equal to the threshold. For example, if you set this parameter to 100, you can query domain names with less than 100 queries.

12

Response parameters

ParameterTypeDescriptionExample
object
PageSizeinteger

The number of entries returned per page.

5
RequestIdstring

The ID of the request.

CC625C21-8832-4683-BF10-C3CFB1A4FA13
PageNumberinteger

The page number of the returned page.

1
TotalPagesinteger

The total number of returned pages.

14
TotalItemsinteger

The total number of data records.

68
Statisticsobject []

The statistics on the Domain Name System (DNS) requests.

DomainNamestring

The domain name.

ali-gslb.com
Countlong

The number of DNS requests.

35509014
DomainTypestring

The type of the domain name. The parameter value is not case-sensitive. Valid values:

PUBLIC (default): hosted public domain name

CACHE: cache-accelerated domain name

PUBLIC
resolveAnalysisStatusstring

Indicates whether the DNS traffic analysis feature is enabled for the domain name. Valid values:

  • OPEN
  • CLOSE
OPEN

Examples

Sample success responses

JSONformat

{
  "PageSize": 5,
  "RequestId": "CC625C21-8832-4683-BF10-C3CFB1A4FA13",
  "PageNumber": 1,
  "TotalPages": 14,
  "TotalItems": 68,
  "Statistics": {
    "Statistic": [
      {
        "DomainName": "ali-gslb.com",
        "Count": 35509014,
        "DomainType": "PUBLIC",
        "resolveAnalysisStatus": "OPEN"
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-01-18The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.