DescribeDomainResolveStatisticsSummary - Alibaba Cloud DNS

Queries the request volumes for all paid domain names in your account.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Keyword	string	No	The keyword. This parameter is used with SearchMode.	test
SearchMode	string	No	The search mode of the keyword. Valid values: LIKE: fuzzy search (default) EXACT: exact match	EXACT
Direction	string	No	The sort direction. Valid values: DESC: descending ASC: ascending	DESC
Threshold	integer	No	The threshold for the number of DNS queries. This parameter filters domain names by query volume. If you do not specify this parameter, the operation returns domain names with more than zero queries. If you specify a value less than 0, the operation returns all domain names. If you specify 0, the operation returns domain names with zero queries. If you specify a value greater than 0, the operation returns domain names with a query volume up to this value.	-1
StartDate	string	Yes	The start date. The format is yyyy-MM-dd. For example, 2023-03-01.	2023-03-01
EndDate	string	No	The end date. The format is yyyy-MM-dd. For example, 2023-03-13.	2023-03-01
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 for a paged query. The maximum value is 1000. The minimum value is 1.	10
Lang	string	No	The language. Valid values: zh, en, and ja.	zh

Response elements

Element	Type	Description	Example
	object	PopResultDTO<PageResult>
RequestId	string	The unique ID of the request.	6856BCF6-11D6-4D7E-AC53-FD579933522B
PageSize	integer	The number of entries returned on each page. The maximum value is 100. The default value is 20.	20
PageNumber	integer	The page number. The value starts from 1. The default value is 1.	1
TotalPages	integer	The total number of pages.	1
TotalItems	integer	The total number of entries.	1
Statistics	array<object>	The list of statistics.
	object
DomainName	string	The domain name.	example.com
Count	string	The number of requests.	35509014
DomainType	string	The type of the domain name. PUBLIC: Authoritative domain name CACHE: Authoritative proxy domain name	CACHE

Examples

Success response

JSON format

{
  "RequestId": "6856BCF6-11D6-4D7E-AC53-FD579933522B",
  "PageSize": 20,
  "PageNumber": 1,
  "TotalPages": 1,
  "TotalItems": 1,
  "Statistics": [
    {
      "DomainName": "example.com",
      "Count": "35509014",
      "DomainType": "CACHE"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
400	Statistics.TooManyResults	Your query has produced too many results.
400	Statistics.InvalidDomainName	Your query param DomainName is invalid.
400	Statistics.InvalidStartDate	Your query param StartDate is invalid.
400	Statistics.InvalidEndDate	Your query param EndDate is invalid.
400	Statistics.InvalidSearchMode	Your query param SearchMode is invalid.
400	Statistics.InvalidOrderDirection	Your query param OrderDirection is invalid.
400	Statistics.InvalidDomainType	Your query param DomainType is invalid.
400	Statistics.QuotaExceededTime	Your query time range exceeds 90 days.
400	Sys.ParamsError	Your query param is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.