开发者社区 问答 正文

如何查询 API 调用的 Qps 监控数据?



描述


查询指定API的监控信息:QPS

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


请求参数


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


返回参数


名称类型描述
CallSuccessesMonitorItem由 MonitorItem 组成的格式,返回API调用成功监控信息
CallFailsMonitorItem由 MonitorItem 组成的格式,返回API调用失败监控信息


示例



请求示例







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

查询指定API的QPS监控信息是针对阿里云开放API用户的一项功能,它允许用户获取指定API在特定时间范围内的每秒查询次数(QPS)统计。此监控功能主要针对线上环境中的API调用进行统计,测试环境的调用数据不包括在内。以下是使用此功能时涉及的请求参数与返回参数详情:

请求参数

  • Action: 必填参数,操作接口名,固定取值为 DescribeApiQpsData
  • GroupId: 可选参数,分组编号。
  • ApiId: 必填参数,需查询的API编号。
  • StartTime: 必填参数,开始时间,遵循ISO8601标准,采用UTC时间,格式为 YYYY-MM-DDThh:mm:ssZ
  • EndTime: 必填参数,结束时间,格式同上。

返回参数

  • CallSuccesses: 包含由 MonitorItem 组成的数组,每个项代表一个时间点上的API调用成功情况,包含:
    • ItemValue: 成功调用的QPS值。
    • ItemTime: 对应的成功调用时间戳,格式为 YYYY-MM-DDThh:mm:ssZ
  • CallFails: 同样由 MonitorItem 组成,但记录的是API调用失败的监控信息,结构与 CallSuccesses 相似。

示例

具体请求示例和返回结果请参考知识库中提供的文档资料,其中包含了正常返回示例的JSON格式,展示了如何通过API调用来获取到的成功与失败调用的QPS统计数据及其对应的时间戳。

通过上述参数配置与调用,您可以有效监控指定API的QPS变化趋势,进而分析和优化API性能。

请注意,实际应用中根据业务需求合理设置查询时间段,并结合返回的QPS数据来评估API承载能力及适时调整策略,以确保服务稳定高效运行。


注:以上信息基于提供的参考资料整合而成,具体操作时请参照阿里云官方文档的最新说明。

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