描述
查询指定API的监控信息:Latency(ms)
名称 | 类型 | 是否必须 | 描述 |
Action | String | 是 | 操作接口名,系统规定参数,取值:DescribeApiLatencyData |
GroupId | String | 否 | 分组编号 |
ApiId | String | 是 | API编号 |
StartTime | String | 是 | 开始时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ |
EndTime | String | 是 | 结束时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ |
名称 | 类型 | 描述 |
CallLatencys | MonitorItem | 由 MonitorItem 组成的格式,返回API调用延迟监控信息 |
版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。
查询指定API监控信息中的响应时间(Latency(ms))功能,是专为开放API用户设计的,旨在帮助用户获取指定API在特定时间段内的响应时间统计数据。此功能专注于线上环境API调用的性能分析,并不涵盖测试环境的API数据。
要使用此功能,您需要通过API调用提供以下参数:
Action:String 类型,是必填项,固定值为 DescribeApiLatencyData
,用于指定所要执行的操作接口。
GroupId:String 类型,可选,表示分组编号,如果您需要按分组查询,请提供该编号。
ApiId:String 类型,是必填项,表示您想查询的API编号。
StartTime:String 类型,是必填项,指定了统计的开始时间。时间格式需遵循ISO8601标准并使用UTC时间,例如:2016-07-23T08:28:48Z
。
EndTime:String 类型,是必填项,指定了统计的结束时间。时间格式与开始时间相同。
调用成功后,API将返回以下结构的数据,重点在于CallLatencys,它由一系列MonitorItem组成,每个MonitorItem包含:
ItemValue:String 类型,表示具体的响应时间数值。
ItemTime:String 类型,表示该响应时间数据对应的记录时间,同样遵循ISO8601 UTC时间格式。
具体请求示例和响应示例已包含在知识库资料中,请直接参考给出的文档以获取详细的请求构造方法及预期的响应格式。这些示例会展示如何构造实际的API调用请求以及可能的返回结果,包括成功的数据结构示例。
apigateway:DescribeApiLatencyData
操作。通过上述说明,您可以根据具体需求构造API请求,以获取指定API的响应时间监控数据。