DescribeRecordStatisticsSummary - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries statistics on the request volume for all subdomains of a specified domain name.

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:DescribeRecordStatisticsSummary

get

*Domain

acs:alidns::{#accountId}:domain/{#DomainName}

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the response. Valid values: zh: Chinese en: English The default value is en.	en
PageNumber	integer	No	The page number. The value starts from 1. The default value is 1.	1
PageSize	integer	No	The number of entries to return on each page. The maximum value is 100, the minimum value is 1, and the default value is 20.	20
StartDate	string	Yes	The start date of the query. The format is YYYY-MM-DD. You can query data only from the last 90 days. The value of `StartDate` must be greater than or equal to the current date minus 90 days.	2019-07-04
EndDate	string	No	The end date of the query. The format is YYYY-MM-DD. The default value is the current day.	2019-07-04
DomainName	string	Yes	The domain name.	example.top
SearchMode	string	No	The search mode for the keyword. Valid values: LIKE: fuzzy search (default) EXACT: exact match	EXACT
Keyword	string	No	The keyword. The search is performed in the %KeyWord% format and is not case-sensitive.	test
Threshold	integer	No	The threshold for the number of DNS requests. This operation returns data for subdomains whose request count is less than or equal to this value. If you set this parameter to 100, subdomains with a request count from 1 to 100 are returned. If you leave this parameter empty, all subdomains that have DNS requests are returned. If you set this parameter to 0, subdomains with no DNS requests are returned. If a domain name is added on the current day and has no requests, you can query its data on the next day.	12
DomainType	string	No	The type of the domain name. This parameter is not case-sensitive. Valid values: PUBLIC: authoritative domain name (default) CACHE: proxy domain name	PUBLIC

Response elements

Element	Type	Description	Example
	object
PageSize	integer	The number of entries returned per page. The maximum value is 100. The default value is 20.	20
RequestId	string	The unique ID of the request.	E49F0023-4A98-486F-8BA3-6003D5664105
PageNumber	integer	The page number. The value starts from 1. The default value is 1.	1
TotalPages	integer	The total number of pages returned.	1
TotalItems	integer	The total number of entries returned.	3
Statistics	object
Statistic	array<object>	The list of request volume data.
	object
SubDomain	string	The subdomain.	example.top
Count	integer	The number of requests.	838711553

Examples

Success response

JSON format

{
  "PageSize": 20,
  "RequestId": "E49F0023-4A98-486F-8BA3-6003D5664105",
  "PageNumber": 1,
  "TotalPages": 1,
  "TotalItems": 3,
  "Statistics": {
    "Statistic": [
      {
        "SubDomain": "example.top",
        "Count": 838711553
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.