查询 API 错误分布数据 - 开发指南| 阿里云

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

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	DescribeApiErrorData	系统规定参数。取值：DescribeApiErrorData。
ApiId	String	是	d6f679aeb3be4b91b3688e887ca1fe16	API编号
EndTime	String	是	016-07-23T09:28:48Z	结束时间，按照ISO8601标准表示，并需要使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ
StartTime	String	是	2016-07-23T08:28:48Z	开始时间，按照ISO8601标准表示，并需要使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ
GroupId	String	否	63be9002440b4778a61122f14c2b2bbb	分组编号

返回数据


名称	类型	示例值	描述
ClientErrors	Array		由 MonitorItem 组成的格式，返回API调用(客户端原因)失败监控信息。所有返回给调用者的http状态码为4XX的调用都统计为客户端原因的失败调用。
MonitorItem			由 MonitorItem 组成的格式，返回API调用(客户端原因)失败监控信息。所有返回给调用者的http状态码为4XX的调用都统计为客户端原因的失败调用。
ItemTime	String	2016-07-28T08:20:00Z	对应时间，按照ISO8601标准表示，并需要使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ
ItemValue	String	2	对应值
RequestId	String	CEF72CEB-54B6-4AE8-B225-F876FF7BZ001	请求ID
ServerErrors	Array		由 MonitorItem 组成的格式，返回API调用(服务端原因)失败监控信息。所有返回给调用者的http状态码为5XX的调用都统计为服务端原因的失败调用。
MonitorItem			由 MonitorItem 组成的格式，返回API调用(服务端原因)失败监控信息。所有返回给调用者的http状态码为5XX的调用都统计为服务端原因的失败调用。
ItemTime	String	2016-07-28T08:22:00Z	对应时间，按照ISO8601标准表示，并需要使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ
ItemValue	String	1	对应值

示例

请求示例


http(s)://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribeApiErrorData
&ApiId=d6f679aeb3be4b91b3688e887ca1fe16    
&EndTime=016-07-23T09:28:48Z
&StartTime=2016-07-23T08:28:48Z
&<公共请求参数>

正常返回示例

XML 格式

<DescribeApiErrorDataResponse>
      <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ001</RequestId>
      <ClientErrors>
            <MonitorItem>
                  <ItemTime>2016-07-28T08:20:00Z</ItemTime>
                  <ItemValue>2</ItemValue>
            </MonitorItem>
            <MonitorItem>
                  <ItemTime>2016-07-28T08:22:00Z</ItemTime>
                  <ItemValue>5</ItemValue>
            </MonitorItem>
            <MonitorItem>
                  <ItemTime>2016-07-28T08:24:00Z</ItemTime>
                  <ItemValue>6</ItemValue>
            </MonitorItem>
      </ClientErrors>
      <ServerErrors>
            <MonitorItem>
                  <ItemTime>2016-07-28T08:20:00Z</ItemTime>
                  <ItemValue>0</ItemValue>
            </MonitorItem>
            <MonitorItem>
                  <ItemTime>2016-07-28T08:22:00Z</ItemTime>
                  <ItemValue>1</ItemValue>
            </MonitorItem>
            <MonitorItem>
                  <ItemTime>2016-07-28T08:24:00Z</ItemTime>
                  <ItemValue>1</ItemValue>
            </MonitorItem>
      </ServerErrors>
</DescribeApiErrorDataResponse>

JSON 格式

{
	"RequestId":"CEF72CEB-54B6-4AE8-B225-F876FF7BZ001",
	"ClientErrors":{
		"MonitorItem":[
			{
				"ItemTime":"2016-07-28T08:20:00Z",
				"ItemValue":"2"
			},
			{
				"ItemTime":"2016-07-28T08:22:00Z",
				"ItemValue":"5"
			},
			{
				"ItemTime":"2016-07-28T08:24:00Z",
				"ItemValue":"6"
			}
		]
	},
	"ServerErrors":{
		"MonitorItem":[
			{
				"ItemTime":"2016-07-28T08:20:00Z",
				"ItemValue":"0"
			},
			{
				"ItemTime":"2016-07-28T08:22:00Z",
				"ItemValue":"1"
			},
			{
				"ItemTime":"2016-07-28T08:24:00Z",
				"ItemValue":"1"
			}
		]
	}
}

错误码

访问错误中心查看更多错误码。