开发者社区 问答 正文

如何查询 API 错误分布数据?



描述


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

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


请求参数


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


返回参数


名称类型描述
ClientErrorsMonitorItem由 MonitorItem 组成的格式,返回API调用(客户端原因)失败监控信息。所有返回给调用者的http状态码为4XX的调用都统计为客户端原因的失败调用。
ServerErrorsMonitorItem由 MonitorItem 组成的格式,返回API调用(服务端原因)失败监控信息。所有返回给调用者的http状态码为5XX的调用都统计为服务端原因的失败调用。


示例



请求示例







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

为了查询指定API的监控信息,特别是关注失败调用的统计数据,您可以使用阿里云API网关提供的相关接口。根据您的需求,这里没有直接提供DescribeApiErrorData的文档详情,但我们可以依据已有的类似接口文档来构建一个大致的操作框架和理解。以下是基于现有资料整理的指南:

请求参数说明

  1. Action: String, 必填

    • 描述:操作接口名,系统规定参数,理论上应为查询错误数据的相应接口名称,尽管具体名称未直接给出,但可参考其他接口如DescribeApiQpsDataDescribeApiTrafficData的格式推测,此处假设存在一个类似的接口用于查询错误统计,例如DescribeApiErrorData
  2. GroupId: String, 可选

    • 描述:分组编号,如果API属于某个分组,则需要提供该编号。
  3. ApiId: String, 必填

    • 描述:您想要查询的API编号,这是唯一标识API的ID。
  4. StartTime: String, 必填

    • 描述:开始时间,按照ISO8601标准表示,并使用UTC时间。格式为 YYYY-MM-DDThh:mm:ssZ
  5. EndTime: String, 必填

    • 描述:结束时间,格式同上。这与StartTime一起定义了您想要查询的时间范围。

返回参数说明

  • ClientErrors: MonitorItem数组

    • 描述:返回API调用因客户端原因(HTTP状态码4XX)失败的监控信息。每个MonitorItem包含:
    • ItemValue: 对应值,即失败次数。
    • ItemTime: 对应时间,记录失败发生的具体时间点,格式为 YYYY-MM-DDThh:mm:ssZ
  • ServerErrors: MonitorItem数组

    • 描述:返回API调用因服务端原因(HTTP状态码5XX)失败的监控信息。结构与ClientErrors相同。

示例请求流程

虽然没有直接提供示例请求内容,但根据描述,构造请求时应遵循以下模式:

  1. 确定接口:首先确认是否有直接对应的DescribeApiErrorData接口可用,或使用相似功能的接口进行调整以满足查询失败调用统计的需求。

  2. 准备参数:收集必要的参数值,包括ApiId、所需查询时间范围的StartTimeEndTime,以及如果有特定分组需求的GroupId

  3. 构造请求:根据阿里云API网关的调用规范,将上述参数组织成HTTP请求。通常,这会涉及构造一个GET或POST请求,其中包含所有必需的参数及签名信息。可以利用OpenAPI Explorer简化此过程,它能自动生成请求示例并处理签名问题。

  4. 发送请求:通过编程方式或使用Postman、cURL等工具发送构造好的请求到阿里云API网关指定的endpoint。

  5. 解析响应:接收并解析API返回的数据,提取ClientErrorsServerErrors中的监控信息,分析失败调用的原因和趋势。

请注意,实际操作前请查阅最新的阿里云API网关官方文档,确保使用的接口名称、参数格式及调用方法准确无误。

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