DescribeStatisticSummary - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Call the DescribeStatisticSummary operation to retrieve a summary of yesterday's request volume. This summary includes the top three zones and top three VPCs ranked by request volume.

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

pvtz:DescribeStatisticSummary

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the response. Valid values: zh: Chinese. en: English. Default value: en.	zh
UserClientIp	string	No	The user's IP address.	127.0.XX.XX

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of requests from yesterday.	2254
RequestId	string	The unique request ID.	A73F3BD0-B1A8-42A9-A9B6-689BBABC4891
ZoneRequestTops	object
ZoneRequestTop	array<object>	The top three zones by request volume.
	object	Details.
RequestCount	integer	The number of requests from yesterday.	2251
ZoneName	string	The zone name.	test.com
BizType	string	The service type. Valid values: AUTH_ZONE: Authoritative zone. RESOLVER_RULE: Forwarding rule. INBOUND: Inbound endpoint.	AUTH_ZONE
VpcRequestTops	object
VpcRequestTop	array<object>	The top three VPCs by request volume.
	object	Details.
VpcId	string	The VPC ID.	vpc-f8zvrvr1payllgz38****
VpcType	string	The VPC type. Valid values: STANDARD: Standard VPC. EDS: Elastic Desktop Service (EDS) VPC.	STANDARD
RegionName	string	The region name.	华北 2
TunnelId	string	The tunnel ID.	tun-7h33lkqfuhgnyy****
RequestCount	integer	The number of requests from yesterday.	2254
RegionId	string	The region ID.	cn-beijing

If you do not specify the `BizType` parameter, the returned parameters are described as follows. `TotalCount` is the total number of requests for authoritative zones, forwarding rules, and inbound endpoints. `ZoneRequestTops` lists the top zones by request volume, which includes authoritative zones and forwarding rules but excludes inbound endpoints. `VpcRequestTops` lists the top VPCs by total request volume, which includes requests from authoritative zones, forwarding rules, and inbound endpoints.

Examples

Success response

JSON format

{
  "TotalCount": 2254,
  "RequestId": "A73F3BD0-B1A8-42A9-A9B6-689BBABC4891",
  "ZoneRequestTops": {
    "ZoneRequestTop": [
      {
        "RequestCount": 2251,
        "ZoneName": "test.com",
        "BizType": "AUTH_ZONE"
      }
    ]
  },
  "VpcRequestTops": {
    "VpcRequestTop": [
      {
        "VpcId": "vpc-f8zvrvr1payllgz38****",
        "VpcType": "STANDARD",
        "RegionName": "华北 2",
        "TunnelId": "tun-7h33lkqfuhgnyy****",
        "RequestCount": 2254,
        "RegionId": "cn-beijing"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.