全部产品

查询 API 错误分布数据

更新时间:2017-07-05 15:14:59

描述

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

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

请求参数

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

返回参数

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

示例

请求示例

  1. https://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribeApiErrorData
  2. &GroupId=63be9002440b4778a61122f14c2b2bbb
  3. &ApiId=d6f679aeb3be4b91b3688e887ca1fe16
  4. &StartTime=2016-07-23T08:28:48Z
  5. &EndTime=2016-07-23T09:28:48Z
  6. &<公共请求参数>

返回示例

XML格式

  1. <DescribeApiErrorDataResponse>
  2. <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ001</RequestId>
  3. <ClientErrors>
  4. <MonitorItem>
  5. <ItemTime>2016-07-28T08:20:00Z</ItemTime>
  6. <ItemValue>2</ItemValue>
  7. </MonitorItem>
  8. <MonitorItem>
  9. <ItemTime>2016-07-28T08:22:00Z</ItemTime>
  10. <ItemValue>5</ItemValue>
  11. </MonitorItem>
  12. <MonitorItem>
  13. <ItemTime>2016-07-28T08:24:00Z</ItemTime>
  14. <ItemValue>6</ItemValue>
  15. </MonitorItem>
  16. </ClientErrors>
  17. <ServerErrors>
  18. <MonitorItem>
  19. <ItemTime>2016-07-28T08:20:00Z</ItemTime>
  20. <ItemValue>0</ItemValue>
  21. </MonitorItem>
  22. <MonitorItem>
  23. <ItemTime>2016-07-28T08:22:00Z</ItemTime>
  24. <ItemValue>1</ItemValue>
  25. </MonitorItem>
  26. <MonitorItem>
  27. <ItemTime>2016-07-28T08:24:00Z</ItemTime>
  28. <ItemValue>1</ItemValue>
  29. </MonitorItem>
  30. </ServerErrors>
  31. </DescribeApiErrorDataResponse>

JSON格式

  1. {
  2. "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ001",
  3. "ClientErrors": {
  4. "MonitorItem": [
  5. {
  6. "ItemTime": "2016-07-28T08:20:00Z",
  7. "ItemValue": "2"
  8. },
  9. {
  10. "ItemTime": "2016-07-28T08:22:00Z",
  11. "ItemValue": "5"
  12. },
  13. {
  14. "ItemTime": "2016-07-28T08:24:00Z",
  15. "ItemValue": "6"
  16. }
  17. ]
  18. },
  19. "ServerErrors": {
  20. "MonitorItem": [
  21. {
  22. "ItemTime": "2016-07-28T08:20:00Z",
  23. "ItemValue": "0"
  24. },
  25. {
  26. "ItemTime": "2016-07-28T08:22:00Z",
  27. "ItemValue": "1"
  28. },
  29. {
  30. "ItemTime": "2016-07-28T08:24:00Z",
  31. "ItemValue": "1"
  32. }
  33. ]
  34. }
  35. }