查询 API 调用的 Qps 监控数据_API 管理相关接口_API 参考_开发指南

描述

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

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

请求参数

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

返回参数

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

示例

请求示例

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

返回示例

XML格式

<DescribeApiQpsDataResponse>
    <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ001</RequestId>
    <CallSuccesses>
        <MonitorItem>
            <ItemTime>2016-07-28T08:20:00Z</ItemTime>
            <ItemValue>670</ItemValue>
        </MonitorItem>
        <MonitorItem>
            <ItemTime>2016-07-28T08:22:00Z</ItemTime>
            <ItemValue>770</ItemValue>
        </MonitorItem>
        <MonitorItem>
            <ItemTime>2016-07-28T08:24:00Z</ItemTime>
            <ItemValue>650</ItemValue>
        </MonitorItem>
    </CallSuccesses>
    <CallFails>
        <MonitorItem>
            <ItemTime>2016-07-28T08:20:00Z</ItemTime>
            <ItemValue>0</ItemValue>
        </MonitorItem>
        <MonitorItem>
            <ItemTime>2016-07-28T08:22:00Z</ItemTime>
            <ItemValue>0</ItemValue>
        </MonitorItem>
        <MonitorItem>
            <ItemTime>2016-07-28T08:24:00Z</ItemTime>
            <ItemValue>1</ItemValue>
        </MonitorItem>
    </CallFails>
</DescribeApiQpsDataResponse>

JSON格式

{
    "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ001",
    "CallSuccesses": {
      "MonitorItem": [
        {
          "ItemTime": "2016-07-28T08:20:00Z",
          "ItemValue": "670"
        },
        {
          "ItemTime": "2016-07-28T08:22:00Z",
          "ItemValue": "770"
        },
        {
          "ItemTime": "2016-07-28T08:24:00Z",
          "ItemValue": "650"
        }
      ]
    },
    "CallFails": {
      "MonitorItem": [
        {
          "ItemTime": "2016-07-28T08:20:00Z",
          "ItemValue": "0"
        },
        {
          "ItemTime": "2016-07-28T08:22:00Z",
          "ItemValue": "0"
        },
        {
          "ItemTime": "2016-07-28T08:24:00Z",
          "ItemValue": "1"
        }
      ]
    }
  }