DescribeGroupLatency - API Gateway - Alibaba Cloud Documentation Center

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

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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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.
MonitorItem	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