首页 API 网关 开发指南 API参考指南 API目录 监控 DescribeApiTrafficData - 查询API监控数据中流量统计数据

DescribeApiTrafficData - 查询API监控数据中流量统计数据

查询指定API监控数据中对流量的统计数据。

接口说明

  • 此功能面向开放API的用户
  • 监控功能默认对线上环境的API做统计,不包括测试环境的API调用

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
apigateway:DescribeApiTrafficDataRead
  • ApiGateway
    acs:apigateway:*:{#accountId}:*

请求参数

名称类型必填描述示例值
ApiIdstring

API编号

d6f679aeb3be4b91b3688e887ca1fe16
GroupIdstring

分组编号

63be9002440b4778a61122f14c2b2bbb
StartTimestring

开始时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ

2016-07-23T08:28:48Z
EndTimestring

结束时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ

2016-07-23T09:28:48Z
StageNamestring

环境名称,取值为:

  • RELEASE:线上

  • TEST:测试

  • PRE:预发

RELEASE

返回参数

名称类型描述示例值
object
RequestIdstring

请求ID

CEF72CEB-54B6-4AE8-B225-F876FF7BZ001
CallUploadsarray

由 MonitorItem 组成的格式,返回API调用上行数据流量监控信息

object
ItemValuestring

对应值

670
ItemTimestring

对应时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ

2016-07-28T08:20:00Z
CallDownloadsarray

由 MonitorItem 组成的格式,返回API调用下行数据流量监控信息

object
ItemValuestring

对应值

0
ItemTimestring

对应时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ

2016-07-28T08:20:00Z

示例

正常返回示例

JSON格式

{
    "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ001",
    "CallUploads": {
      "MonitorItem": [
        {
          "ItemTime": "2016-07-28T08:20:00Z",
          "ItemValue": "1670"
        },
        {
          "ItemTime": "2016-07-28T08:22:00Z",
          "ItemValue": "1770"
        },
        {
          "ItemTime": "2016-07-28T08:24:00Z",
          "ItemValue": "1650"
        }
      ]
    },
    "CallDownloads": {
      "MonitorItem": [
        {
          "ItemTime": "2016-07-28T08:20:00Z",
          "ItemValue": "1650"
        },
        {
          "ItemTime": "2016-07-28T08:22:00Z",
          "ItemValue": "1670"
        },
        {
          "ItemTime": "2016-07-28T08:24:00Z",
          "ItemValue": "1770"
        }
      ]
    }
}

XML格式

<DescribeApiTrafficDataResponse>
    <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ001</RequestId>
    <CallUploads>
        <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>
    </CallUploads>
    <CallDownloads>
        <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>
    </CallDownloads>
</DescribeApiTrafficDataResponse>

错误码

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

变更历史

变更时间变更内容概要操作
2022-08-29
变更项变更内容
阿里云首页 API 网关 相关技术圈