开发者社区 问答 正文

如何查询 API 响应时间监控数据?



描述


查询指定API的监控信息:Latency(ms)

  • 此功能面向开放API的用户
  • 该接口用于查询指定API监控数据中对响应时间的统计数据
  • 监控功能默认对线上环境的API做统计,不包括测试环境的API调用


请求参数


名称类型是否必须描述
ActionString操作接口名,系统规定参数,取值:DescribeApiLatencyData
GroupIdString分组编号
ApiIdStringAPI编号
StartTimeString开始时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ
EndTimeString结束时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ


返回参数


名称类型描述
CallLatencysMonitorItem由 MonitorItem 组成的格式,返回API调用延迟监控信息


示例



请求示例





展开
收起
轩墨 2017-10-26 14:04:31 1960 分享 版权
阿里云 AI 助理回答

查询指定API监控信息中的响应时间(Latency(ms))功能,是专为开放API用户设计的,旨在帮助用户获取指定API在特定时间段内的响应时间统计数据。此功能专注于线上环境API调用的性能分析,并不涵盖测试环境的API数据。

请求参数

要使用此功能,您需要通过API调用提供以下参数:

  • ActionString 类型,是必填项,固定值为 DescribeApiLatencyData,用于指定所要执行的操作接口。

  • GroupIdString 类型,可选,表示分组编号,如果您需要按分组查询,请提供该编号。

  • ApiIdString 类型,是必填项,表示您想查询的API编号。

  • StartTimeString 类型,是必填项,指定了统计的开始时间。时间格式需遵循ISO8601标准并使用UTC时间,例如:2016-07-23T08:28:48Z

  • EndTimeString 类型,是必填项,指定了统计的结束时间。时间格式与开始时间相同。

返回参数

调用成功后,API将返回以下结构的数据,重点在于CallLatencys,它由一系列MonitorItem组成,每个MonitorItem包含:

  • ItemValueString 类型,表示具体的响应时间数值。

  • ItemTimeString 类型,表示该响应时间数据对应的记录时间,同样遵循ISO8601 UTC时间格式。

示例

具体请求示例和响应示例已包含在知识库资料中,请直接参考给出的文档以获取详细的请求构造方法及预期的响应格式。这些示例会展示如何构造实际的API调用请求以及可能的返回结果,包括成功的数据结构示例。

注意事项

  • 请确保您对目标API具有读取(Read)权限,且在RAM权限策略中正确配置了apigateway:DescribeApiLatencyData操作。
  • 只有线上环境(RELEASE)的API调用会被统计,测试环境(TEST)或预发环境(PRE)的数据不在统计范围内。
  • 时间区间(StartTime至EndTime)需要符合实际有效的时间段,并且时间格式必须严格遵循ISO8601 UTC标准。

通过上述说明,您可以根据具体需求构造API请求,以获取指定API的响应时间监控数据。

有帮助
无帮助
AI 助理回答生成答案可能存在不准确,仅供参考
0 条回答
写回答
取消 提交回答