All Products
Search
Document Center

:DescribeDomainResolveStatisticsSummary

Last Updated:Oct 11, 2024

Queries the resolution requests of all paid domain names within your account.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
alidns:DescribeDomainResolveStatisticsSummary
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
KeywordstringNo

The keyword. The Keyword parameter is used together with the SearchMode parameter.

test
SearchModestringNo

The search mode of the keyword. Valid values:

  • LIKE (default): fuzzy search
  • EXACT: exact search
EXACT
DirectionstringNo

The order in which you want to sort the returned entries. Valid values:

  • DESC: the descending order
  • ASC: the ascending order
DESC
ThresholdlongNo

The threshold for the number of Domain Name System (DNS) requests. You can query the domain names at the specified quantity level of DNS requests and query the number of DNS requests for each domain name.

If you do not specify this parameter, the data about the domain names that have DNS requests is obtained.

If you set this parameter to a value less than 0, the data about all domain names is obtained.

If you set this parameter to 0, the data about the domain names that do not have DNS requests is obtained.

If you set this parameter to a value greater than 0, the data about the domain names whose number of DNS requests is less than or equal to the value of this parameter is obtained.

-1
StartDatestringYes

The start time in the yyyy-MM-dd format, for example, 2023-03-01.

2023-03-01
EndDatestringNo

The end time in the yyyy-MM-dd format, for example, 2023-03-13.

2023-03-01
PageNumberintegerNo

The number of the page to return. Pages start from page 1. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page. Valid values: 1 to 1000.

10
LangstringNo

The language. Valid values: zh, en, and ja.

zh

Response parameters

ParameterTypeDescriptionExample
object

PopResultDTO<PageResult>

RequestIdstring

The request ID.

6856BCF6-11D6-4D7E-AC53-FD579933522B
PageSizeinteger

The number of entries per page. Maximum value: 100. Default value: 20.

10
PageNumberinteger

The page number. Pages start from page 1. Default value: 1.

1
TotalPagesinteger

The total number of pages returned.

1
TotalItemsinteger

The total number of entries returned.

1
Statisticsarray<object>

The statistics.

Statisticobject
DomainNamestring

The domain name.

example.com
Countstring

The number of DNS requests.

35509014
DomainTypestring

The type of the domain name. Valid values:

  • PUBLIC: hosted public domain name
  • CACHE: cache-accelerated domain name
CACHE

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError message
400Statistics.TooManyResultsYour query has produced too many results.
400Statistics.InvalidDomainNameYour query param DomainName is invalid.
400Statistics.InvalidStartDateYour query param StartDate is invalid.
400Statistics.InvalidEndDateYour query param EndDate is invalid.
400Statistics.InvalidSearchModeYour query param SearchMode is invalid.
400Statistics.InvalidOrderDirectionYour query param OrderDirection is invalid.
400Statistics.InvalidDomainTypeYour query param DomainType is invalid.
400Statistics.QuotaExceededTimeYour query time range exceeds 90 days.
400Sys.ParamsErrorYour query param is invalid.

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

Change history

Change timeSummary of changesOperation
2024-01-29The Error code has changedView Change Details