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

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

接口说明

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值

名称	类型	必填	描述	示例值
ApiId	string	是	API 编号	d6f679aeb3be4b91b3688e887ca1fe16
GroupId	string	否	分组编号	63be9002440b4778a61122f14c2b2bbb
StartTime	string	是	开始时间，按照 ISO8601 标准表示，并需要使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ	2016-07-23T08:28:48Z
EndTime	string	是	结束时间，按照 ISO8601 标准表示，并需要使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ	2016-07-23T09:28:48Z
StageName	string	否	环境名称，取值为： RELEASE：线上 TEST：测试 PRE：预发	RELEASE

返回参数

名称	类型	描述	示例值

名称	类型	描述	示例值
	object
RequestId	string	请求 ID	CEF72CEB-54B6-4AE8-B225-F876FF7BZ001
CallUploads	array<object>	由 MonitorItem 组成的格式，返回 API 调用上行数据流量监控信息
MonitorItem	object
ItemValue	string	对应值	670
ItemTime	string	对应时间，按照 ISO8601 标准表示，并需要使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ	2016-07-28T08:20:00Z
CallDownloads	array<object>	由 MonitorItem 组成的格式，返回 API 调用下行数据流量监控信息
MonitorItem	object
ItemValue	string	对应值	0
ItemTime	string	对应时间，按照 ISO8601 标准表示，并需要使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ	2016-07-28T08:20:00Z

示例

正常返回示例

JSON格式

        

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

错误码

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

变更历史

变更时间	变更内容概要	操作

变更时间	变更内容概要	操作
2024-11-14	OpenAPI 描述信息更新	查看变更详情