全部产品
Search
文档中心

API 网关:DescribeGroupLatency - 查询分组的平均延迟

更新时间:Apr 01, 2024

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
apigateway:DescribeGroupLatencyRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
StartTimestring

开始时间,按照 ISO8601 标准表示,并需要使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ

2023-03-30T16:00:00Z
EndTimestring

结束时间,按照 ISO8601 标准表示,并需要使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ

2023-04-14T06:26:14Z
StageNamestring

指定要查询的环境。

  • RELEASE: 线上
  • PRE: 预发
  • TEST: 测试
RELEASE
GroupIdstring

指定要操作 API 所属分组 ID

d825094fdd114a869f5adb443d9b7ead

返回参数

名称类型描述示例值
object
RequestIdstring

本次请求的 ID。

75DC3AB0-421C-5371-8170-86AEABF77AD0
LatencyPacketobject []

平均时延信息

ItemValuestring

延迟数,单位:ms

100.0
ItemTimestring

时间节点,按照 ISO8601 标准表示,格式为:YYYY-MM-DDThh:mm:ssZ。

2023-03-30T16:10:00Z
Itemstring

指标

  • latency:后端处理延迟
  • gatewayLatency:API 网关处理延迟
latency

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史