DescribePdnsRequestStatistics - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries the request statistics for a specified subdomain.

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

pubdns:DescribePdnsRequestStatistics

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the request and response. The default value is zh. Valid values: zh: Chinese en: English	zh
DomainName	string	No	The primary domain name to query.	example.com
SubDomain	string	No	The subdomain for which to view statistics.	www.example.com
Type	string	No	The type of request statistics to query. Valid values: DOMAIN: queries statistics by domain name. SUB_DOMAIN: queries statistics by subdomain.	DOMAIN
StartDate	string	No	The start date of the query. Use the YYYY-MM-DD format. You can query data from the last 90 days only.	2024-06-14
EndDate	string	No	The end date of the query. Use the YYYY-MM-DD format. The default value is the current date.	2024-07-14
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 100. The default value is 20.	20

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of entries.	49
PageSize	integer	The number of entries returned per page. The maximum value is 100. The default value is 20.	10
RequestId	string	The unique request ID.	536E9CAD-DB30-4647-AC87-AA5CC38C5382
PageNumber	integer	The page number. The value starts from 1. The default value is 1.	1
Data	array<object>	The list of request statistics.
	object	The list of request statistics.
DomainName	string	The domain name.	example.com
SubDomain	string	The subdomain.	www.example.com
V6HttpCount	integer	The number of IPv6 HTTP requests.	0
V6HttpsCount	integer	The number of IPv6 HTTPS requests.	0
TotalCount	integer	The total number of requests.	500
V4HttpCount	integer	The number of IPv4 HTTP requests.	0
V4HttpsCount	integer	The number of IPv4 HTTPS requests.	0
V4Count	integer	The number of IPv4 requests.	0
V6Count	integer	The number of IPv6 requests.	0
HttpCount	integer	The number of HTTP requests.	0
HttpsCount	integer	The number of HTTPS requests. On the Traffic Analysis tab of the Public DNS console, this parameter includes the number of DNS over HTTPS (DoH) requests. Therefore, the number of DoH requests is not separately displayed in the console.	0
DohTotalCount	integer	The total number of DoH requests. This includes the total number of HTTP and HTTPS requests.	0
UdpTotalCount	integer	The total number of UDP requests.	500
IpCount	integer	The number of source IP addresses.	10
ThreatCount	integer	This parameter is not supported in the current version.	-
MaxThreatLevel	string	This parameter is not supported in the current version.	-
ThreatInfo	array<object>	This parameter is not supported in the current version.
	object	This parameter is not supported in the current version.
ThreatType	string	This parameter is not supported in the current version.	-
ThreatLevel	string	This parameter is not supported in the current version.	-

Examples

Success response

JSON format

{
  "TotalCount": 49,
  "PageSize": 10,
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "PageNumber": 1,
  "Data": [
    {
      "DomainName": "example.com",
      "SubDomain": "www.example.com",
      "V6HttpCount": 0,
      "V6HttpsCount": 0,
      "TotalCount": 500,
      "V4HttpCount": 0,
      "V4HttpsCount": 0,
      "V4Count": 0,
      "V6Count": 0,
      "HttpCount": 0,
      "HttpsCount": 0,
      "DohTotalCount": 0,
      "UdpTotalCount": 500,
      "IpCount": 10,
      "ThreatCount": 0,
      "MaxThreatLevel": "-",
      "ThreatInfo": [
        {
          "ThreatType": "-",
          "ThreatLevel": "-"
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.