DescribeApiTrafficData API Reference - API Gateway

Queries the statistics on the traffic of an API.

Operation description

This API is intended for API providers.
Only statistics for API calls made in the release environment are collected by default.

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

apigateway:DescribeApiTrafficData

get

*ApiGroup

acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}

None

Request parameters

Parameter	Type	Required	Description	Example
ApiId	string	Yes	The ID of the API.	d6f679aeb3be4b91b3688e887ca1fe16
GroupId	string	No	The ID of the API group.	63be9002440b4778a61122f14c2b2bbb
StartTime	string	Yes	The start time in UTC. Format: YYYY-MM-DDThh:mm:ssZ	2016-07-23T08:28:48Z
EndTime	string	Yes	The end time in UTC. Format: YYYY-MM-DDThh:mm:ssZ	2016-07-23T09:28:48Z
StageName	string	No	The environment. Valid values: RELEASE TEST: the test environment PRE: the pre-release environment	RELEASE

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	CEF72CEB-54B6-4AE8-B225-F876FF7BZ001
CallUploads	object
MonitorItem	array<object>	The returned uplink traffic data of API calls. It is an array consisting of MonitorItem data.
	object
ItemValue	string	The value corresponding to the monitoring metric.	670
ItemTime	string	The time of the monitoring metric. The time format follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ	2016-07-28T08:20:00Z
CallDownloads	object
MonitorItem	array<object>	The returned downlink traffic data of API calls. It is an array consisting of MonitorItem data.
	object
ItemValue	string	The value corresponding to the monitoring metric.	0
ItemTime	string	The time of the monitoring metric. The time format follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ	2016-07-28T08:20:00Z

Examples

Success response

JSON format

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ001",
  "CallUploads": {
    "MonitorItem": [
      {
        "ItemValue": "670",
        "ItemTime": "2016-07-28T08:20:00Z"
      }
    ]
  },
  "CallDownloads": {
    "MonitorItem": [
      {
        "ItemValue": "0",
        "ItemTime": "2016-07-28T08:20:00Z"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.