DescribeRecordResolveStatisticsSummary - Alibaba Cloud DNS

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

list

*Domain

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

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The domain name.	example.com
DomainType	string	No	The type of the domain name. This parameter is not case-sensitive. Valid values: PUBLIC: an authoritative domain name (default) CACHE: an authoritative proxy domain name	PUBLIC
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	LIKE
Direction	string	No	The sorting direction. Valid values: DESC: descending order (default) ASC: ascending order	DESC
Threshold	integer	No	The resolution count threshold. This parameter lets you query subdomains based on their resolution counts. If you do not specify this parameter, data for subdomains with a resolution count greater than 0 is returned. If you specify a value less than 0, all data is returned. If you specify 0, data for subdomains with a resolution count of 0 is returned. If you specify a value greater than 0, data for subdomains with a resolution count less than or equal to the specified value is returned.	-1
StartDate	string	Yes	The start date. Specify the date in the YYYY-MM-DD format. For example: 2023-03-01.	2023-03-29
EndDate	string	No	The end date. Specify the date in the YYYY-MM-DD format. For example: 2023-03-13.	2023-03-29
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 1000 and 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 request ID.	389DFFA3-77A5-4A9E-BF3D-147C6F98A5BA
PageSize	integer	The number of entries returned per page. The maximum value is 500. The default value is 20.	10
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.	1
Statistics	array<object>	The list of statistics.
	object
SubDomain	string	The subdomain.	test.example.com
DomainName	string	The subdomain.	test.example.com
Count	string	The number of requests.	330
DomainType	string	The type of the domain name. This parameter is not case-sensitive. Valid values: PUBLIC: an authoritative domain name (default) CACHE: an authoritative proxy domain name	PUBLIC

Examples

Success response

JSON format

{
  "RequestId": "389DFFA3-77A5-4A9E-BF3D-147C6F98A5BA",
  "PageSize": 10,
  "PageNumber": 1,
  "TotalPages": 1,
  "TotalItems": 1,
  "Statistics": [
    {
      "SubDomain": "test.example.com",
      "DomainName": "test.example.com",
      "Count": "330",
      "DomainType": "PUBLIC"
    }
  ]
}

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.