DescribeDomainStatisticsSummary - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

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

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
alidns:DescribeDomainStatisticsSummary	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language type.	en
PageNumber	long	Yes	The number of the page to return. Pages start from page 1. Default value: 1.	1
PageSize	long	No	The number of entries per page. Valid values: 1 to 100. Default value: 20.	20
StartDate	string	Yes	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
EndDate	string	No	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
SearchMode	string	No	The search mode of the keyword. Valid values: LIKE: fuzzy match (default). EXACT: exact match.	LIKE
Keyword	string	No	The keyword for searches in %KeyWord% mode. The value is not case-sensitive.	test
Threshold	long	No	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

Parameter	Type	Description	Example
	object
PageSize	integer	The number of entries returned per page.	5
RequestId	string	The ID of the request.	CC625C21-8832-4683-BF10-C3CFB1A4FA13
PageNumber	integer	The page number of the returned page.	1
TotalPages	integer	The total number of returned pages.	14
TotalItems	integer	The total number of data records.	68
Statistics	array<object>	The statistics on the Domain Name System (DNS) requests.
Statistic	object
DomainName	string	The domain name.	ali-gslb.com
Count	long	The number of DNS requests.	35509014
DomainType	string	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
resolveAnalysisStatus	string	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 time	Summary of changes	Operation
2024-01-18	The response structure of the API has changed	View Change Details