All Products
Search
Document Center

API Gateway:DescribeGroupTraffic

Last Updated:Mar 06, 2025

Queries the traffic of an API group.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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:DescribeGroupTrafficget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
StartTimestringYes

The start time for the query. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ.

2023-01-29T01:27:43Z
EndTimestringYes

The end time for the query. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ.

2023-06-16T02:16:53Z
StageNamestringYes

The environment to which the APIs in the API group are published. Valid values:

  • RELEASE: the production environment
  • PRE: the staging environment
  • TEST: the test environment
RELEASE
GroupIdstringYes

The ID of the API group.

16df9d11caa04900bcafe23b38a81600

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

EF924FE4-2EDD-4CD3-89EC-34E4708574E7
TrafficPerSecondarray<object>

The traffic information per second.

MonitorItemobject
ItemValuestring

The traffic volume per second.

100.0
ItemTimestring

The corresponding time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ.

2023-01-29T01:30:00Z
Itemstring

The metric. Valid values:

  • inbound: traffic consumed by requests
  • outbound: traffic consumed by responses
inbound

Examples

Sample success responses

JSONformat

{
  "RequestId": "EF924FE4-2EDD-4CD3-89EC-34E4708574E7",
  "TrafficPerSecond": {
    "MonitorItem": [
      {
        "ItemValue": "100.0",
        "ItemTime": "2023-01-29T01:30:00Z",
        "Item": "inbound"
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-11-14API Description UpdateView Change Details