DescribeGroupLatency - API Gateway - Alibaba Cloud Documentation Center

Queries the average latency of an API group in an environment.

Debugging

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

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
apigateway:DescribeGroupLatency	get	ApiGroup acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
StartTime	string	Yes	The start time of the time range to query. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ.	2023-03-30T16:00:00Z
EndTime	string	Yes	The end time of the time range to query. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ.	2023-04-14T06:26:14Z
StageName	string	Yes	The environment in which you want to perform the query. Valid values: RELEASE: the production environment PRE: the staging environment TEST: the test environment	RELEASE
GroupId	string	Yes	The ID of the API group.	d825094fdd114a869f5adb443d9b7ead

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	75DC3AB0-421C-5371-8170-86AEABF77AD0
LatencyPacket	array<object>	The latency information.
	object
ItemValue	string	The latency. Unit: ms.	100.0
ItemTime	string	The point in time when the latency data was collected. The format is YYYY-MM-DDThh:mm:ssZ.	2023-03-30T16:10:00Z
Item	string	The metric. Valid values: latency: the backend processing latency gatewayLatency: the API Gateway processing latency	latency

Examples

Sample success responses

JSONformat

{
  "RequestId": "75DC3AB0-421C-5371-8170-86AEABF77AD0",
  "LatencyPacket": {
    "MonitorItem": [
      {
        "ItemValue": "100.0",
        "ItemTime": "2023-03-30T16:10:00Z",
        "Item": "latency"
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history