DescribeRecordResolveStatisticsSummary - - Alibaba Cloud Documentation Center

Queries the number of resolution requests for all subdomain names of a specified domain name.

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:DescribeRecordResolveStatisticsSummary		Domain acs:alidns:*:{#accountId}:domain/{#DomainName}	none	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. The parameter value is not case-sensitive. Valid values: PUBLIC (default): hosted public domain name CACHE: cache-accelerated domain name	PUBLIC
Keyword	string	No	The keyword. Keyword is used together with SearchMode.	test
SearchMode	string	No	The search mode of the keyword. Valid values: LIKE (default): fuzzy search EXACT: exact search	LIKE
Direction	string	No	The order in which the returned entries are sorted. Valid values: DESC (default): descending order ASC: ascending order	DESC
Threshold	long	No	The threshold for the number of Domain Name System (DNS) requests. You can query the subdomain names at the specified quantity level of DNS requests and query the number of DNS requests for each subdomain name. If you do not specify this parameter, the data about the subdomain names that have DNS requests is obtained. If you set this parameter to a value less than 0, the data about all subdomain names is obtained. If you set this parameter to 0, the data about the subdomain names that do not have DNS requests is obtained. If you set this parameter to a value greater than 0, the data about the subdomain names whose number of DNS requests is less than or equal to the value of this parameter is obtained.	-1
StartDate	string	Yes	The start date of the time range to be queried. Specify the time in the yyyy-MM-dd format, such as 2023-03-01.	2023-03-29
EndDate	string	No	The end date of the time range to be queried. Specify the time in the yyyy-MM-dd format, such as 2023-03-13.	2023-03-29
PageNumber	integer	No	The number of the page to return. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Valid values: 1 to 1000.	10
Lang	string	No	The language. Valid values: zh, en, and ja.	zh

Response parameters

Parameter	Type	Description	Example
	object	PopResultDTO<PageResult>
RequestId	string	The request ID.	389DFFA3-77A5-4A9E-BF3D-147C6F98A5BA
PageSize	integer	The number of entries per page. Valid values: 1 to 500. Default value: 20.	10
PageNumber	integer	The page number. Pages start from page 1. Default value: 1.	1
TotalPages	integer	The total number of pages returned.	1
TotalItems	integer	The total number of entries returned.	1
Statistics	array<object>	The statistics.
Statistic	object
SubDomain	string	The subdomain.	test.example.com
DomainName	string	The subdomain name.	tes.example.com
Count	string	The number of DNS requests.	330
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

Examples

Sample success responses

JSONformat

{
  "RequestId": "389DFFA3-77A5-4A9E-BF3D-147C6F98A5BA",
  "PageSize": 10,
  "PageNumber": 1,
  "TotalPages": 1,
  "TotalItems": 1,
  "Statistics": [
    {
      "SubDomain": "test.example.com",
      "DomainName": "tes.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.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-11-23	The Error code has changed	View Change Details
2023-04-04	The Error code has changed. The response structure of the API has changed	View Change Details