All Products
Search
Document Center

API Gateway:DescribeApiQpsData

Last Updated:Mar 01, 2024

Queries the QPS statistics 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.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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
apigateway:DescribeApiQpsDataRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ApiIdstringYes

The ID of the API.

d6f679aeb3be4b91b3688e887ca1fe16
GroupIdstringNo

The ID of the API group.

63be9002440b4778a61122f14c2b2bbb
StartTimestringYes

The start time in UTC. Format: YYYY-MM-DDThh:mm:ssZ

2016-07-23T08:28:48Z
EndTimestringYes

The end time in UTC. Format: YYYY-MM-DDThh:mm:ssZ

2016-07-23T09:28:48Z
StageNamestringNo

The environment. Valid values:

  • RELEASE
  • PRE: the pre-release environment
  • TEST
RELEASE

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

CEF72CEB-54B6-4AE8-B225-F876FF7BZ001
CallSuccessesobject []

The returned information about successful API calls. It is an array consisting of MonitorItem data.

ItemValuestring

The value corresponding to the monitoring metric.

650
ItemTimestring

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:24:00Z
CallFailsobject []

The returned information about failed API calls. It is an array consisting of MonitorItem data.

ItemValuestring

The value corresponding to the monitoring metric.

0
ItemTimestring

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

Sample success responses

JSONformat

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ001",
  "CallSuccesses": {
    "MonitorItem": [
      {
        "ItemValue": "650",
        "ItemTime": "2016-07-28T08:24:00Z"
      }
    ]
  },
  "CallFails": {
    "MonitorItem": [
      {
        "ItemValue": "0",
        "ItemTime": "2016-07-28T08:20:00Z"
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history