DescribeDomainStatisticsSummary - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the response. Valid values: zh (default): Chinese en: English	en
PageNumber	integer	No	The page number. The start value is 1. The default value is 1.	1
PageSize	integer	No	The number of entries per page. The maximum value is 100 and the minimum value is 1. 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 from the last 90 days only. 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 date.	2019-07-04
SearchMode	string	No	The search mode for the keyword. Valid values: LIKE (default): Fuzzy match EXACT: Exact match	LIKE
Keyword	string	No	The keyword. The search is performed in `%KeyWord%` mode and is case-insensitive.	test
Threshold	integer	No	The threshold for the number of requests. This operation returns domain names whose request count is less than or equal to the specified value. For example, if you set this parameter to 100, domain names with 100 or fewer requests are returned. If you do not specify this parameter, all domain names are returned.	12

Response elements

Element	Type	Description	Example
	object
PageSize	integer	The number of entries returned on each page.	5
RequestId	string	The unique request ID.	CC625C21-8832-4683-BF10-C3CFB1A4FA13
PageNumber	integer	The page number of the returned page.	1
TotalPages	integer	The total number of pages.	14
TotalItems	integer	The total number of entries.	68
Statistics	object
Statistic	array<object>	The list of statistics.
	object
DomainName	string	The domain name.	example.com
Count	integer	The number of requests.	35509014
DomainType	string	The type of the domain name. The value is not case-sensitive. Valid values: PUBLIC: An authoritative domain name. This is the default value. CACHE: An authoritative proxy domain name.	PUBLIC
resolveAnalysisStatus	string	The status of the DNS traffic analysis feature for the domain name: OPEN: Enabled CLOSE: Disabled	OPEN

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.