调用DescribeApiLatencyData查询指定API监控数据中对响应时间的统计数据。
查询指定API的监控信息:Latency(ms)
- 此功能面向开放API的用户
- 监控功能默认对线上环境的API做统计,不包括测试环境的API调用
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeApiLatencyData |
系统规定参数。取值:DescribeApiLatencyData。 |
ApiId | String | 是 | d6f679aeb3be4b91b3688e887ca1fe16 |
API编号 |
EndTime | String | 是 | 2016-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 |
分组编号 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
CallLatencys | Array |
由 MonitorItem 组成的格式,返回API调用延迟监控信息 |
|
MonitorItem |
由 MonitorItem 组成的格式,返回API调用延迟监控信息 |
||
ItemTime | String | 2016-07-28T08:20:00Z |
对应时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ |
ItemValue | String | 15 |
对应值 |
RequestId | String | CEF72CEB-54B6-4AE8-B225-F876FF7BZ001 |
请求ID |
示例
请求示例
http(s)://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribeApiLatencyData
&ApiId=d6f679aeb3be4b91b3688e887ca1fe16
&EndTime=2016-07-23T09:28:48Z
&StartTime=2016-07-23T08:28:48Z
&<公共请求参数>
正常返回示例
XML
格式
<DescribeApiLatencyDataResponse>
<RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ001</RequestId>
<CallLatencys>
<MonitorItem>
<ItemTime>2016-07-28T08:20:00Z</ItemTime>
<ItemValue>15</ItemValue>
</MonitorItem>
<MonitorItem>
<ItemTime>2016-07-28T08:22:00Z</ItemTime>
<ItemValue>30</ItemValue>
</MonitorItem>
<MonitorItem>
<ItemTime>2016-07-28T08:24:00Z</ItemTime>
<ItemValue>24</ItemValue>
</MonitorItem>
</CallLatencys>
</DescribeApiLatencyDataResponse>
JSON
格式
{
"RequestId":"CEF72CEB-54B6-4AE8-B225-F876FF7BZ001",
"CallLatencys":{
"MonitorItem":[
{
"ItemTime":"2016-07-28T08:20:00Z",
"ItemValue":"15"
},
{
"ItemTime":"2016-07-28T08:22:00Z",
"ItemValue":"30"
},
{
"ItemTime":"2016-07-28T08:24:00Z",
"ItemValue":"24"
}
]
}
}
错误码
访问错误中心查看更多错误码。