使用DescribeGroupLatency查询指定环境下API分组的平均延迟-API 网关-阿里云

查询指定分组指定环境下，分组的平均延迟。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
apigateway:DescribeGroupLatency	get	*ApiGroup `acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}`	无	无

请求参数

名称	类型	必填	描述	示例值
StartTime	string	是	开始时间，按照 ISO8601 标准表示，并需要使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ	2023-03-30T16:00:00Z
EndTime	string	是	结束时间，按照 ISO8601 标准表示，并需要使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ	2023-04-14T06:26:14Z
StageName	string	是	指定要查询的环境。 RELEASE: 线上 PRE: 预发 TEST: 测试	RELEASE
GroupId	string	是	指定要操作 API 所属分组 ID	d825094fdd114a869f5adb443d9b7ead

返回参数

名称	类型	描述	示例值
	object
RequestId	string	本次请求的 ID。	75DC3AB0-421C-5371-8170-86AEABF77AD0
LatencyPacket	array<object>	平均时延信息
MonitorItem	object
ItemValue	string	延迟数，单位：ms	100.0
ItemTime	string	时间节点，按照 ISO8601 标准表示，格式为：YYYY-MM-DDThh:mm:ssZ。	2023-03-30T16:10:00Z
Item	string	指标 latency：后端处理延迟 gatewayLatency：API 网关处理延迟	latency

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-11-14	OpenAPI 描述信息更新	查看变更详情