DescribeRequestGraph - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries details about the number of requests based on conditions such as a time range.

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

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.	en
UserClientIp	string	No	The user's IP address.	192.168.XX.XX
ZoneId	string	No	The zone ID. Note To query the number of requests for a zone, specify either ZoneId or both BizType and BizId.	29c752a01cd281a20ddcfa****
VpcId	string	No	The ID of the Virtual Private Cloud (VPC).	vpc-f8zvrvr1payllgz38****
StartTimestamp	integer	Yes	The start of the time range to query. This is a UNIX timestamp.	1721036404000
EndTimestamp	integer	Yes	The end of the time range to query. This is a UNIX timestamp.	1721723624000
BizType	string	No	The business type. Valid values: AUTH_ZONE: An authoritative zone. RESOLVER_RULE: A forwarding rule.	AUTH_ZONE
BizId	string	No	The data ID. This parameter is used with BizType. If BizType is set to AUTH_ZONE, set this parameter to the zone ID. If BizType is set to RESOLVER_RULE, set this parameter to the forwarding rule ID.	b9c93a8954c4098731e863c04302f45a

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique ID of the request.	EB71815-A421-4E51-8E8D-667F44ABE633
RequestDetails	object
ZoneRequestTop	array<object>	The details of the requests.
	object	An object that contains details about the number of requests.
Time	string	The time point of the statistical data.	2019-10-21T10:00Z
RequestCount	integer	The number of requests.	103
Timestamp	integer	The time point of the statistical data. This is a UNIX timestamp.	1571652000000

Examples

Success response

JSON format

{
  "RequestId": "EB71815-A421-4E51-8E8D-667F44ABE633",
  "RequestDetails": {
    "ZoneRequestTop": [
      {
        "Time": "2019-10-21T10:00Z",
        "RequestCount": 103,
        "Timestamp": 1571652000000
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.