调用DescribeDomainRealTimeTrafficData查询实时流量

调用DescribeDomainRealTimeTrafficData查询加速域名的流量监控数据。

接口说明

如果您不指定 StartTime 和 EndTime，该接口默认返回过去 1 小时的数据；指定 StartTime 和 EndTime，该接口返回指定时间段的数据。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
cdn:DescribeDomainRealTimeTrafficData	none	Domain `acs:cdn::{#accountId}:domain/{#DomainName}`	无	无

请求参数

名称	类型	必填	描述	示例值
DomainName	string	是	加速域名，多个域名用半角逗号（,）分隔，一次最多支持 100 个域名查询。	example.com
StartTime	string	否	获取数据的起始时间点。日期格式按照 ISO8601 表示法，并使用 UTC 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。	2019-12-10T20:00:00Z
IspNameEn	string	否	运营商英文名。您可以调用 DescribeCdnRegionAndIsp 接口获取。不传该参数默认查询所有地域。	telecom
LocationNameEn	string	否	地域英文名。您可以调用 DescribeCdnRegionAndIsp 接口获取。不传该参数默认查询所有地域。	beijing
EndTime	string	否	获取数据的结束时间点。日期格式按照 ISO8601 表示法，并使用 UTC 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。说明结束时间需大于起始时间。	2019-12-10T20:01:00Z

返回参数

名称	类型	描述	示例值
	object	参数解释。
EndTime	string	结束时间。	2019-12-10T20:01:00Z
StartTime	string	开始时间。	2019-12-10T20:00:00Z
RequestId	string	请求 ID。	A666D44F-19D6-490E-97CF-1A64AB962C57
DomainName	string	加速域名信息。	example.com
DataInterval	string	每条记录的时间间隔，单位：秒。根据单次查询的最大时间跨度不同，该参数固定返回 60（1 分钟）、300（5 分钟）或 3600（1 小时），具体请参见使用说明中返回数据时间粒度。	60
RealTimeTrafficDataPerInterval	array<object>	每个时间间隔的流量数据，单位：Byte。
DataModule	object	每个时间间隔的流量数据。
Value	string	详细使用数据。	0
TimeStamp	string	时间片起始时刻。	2019-12-10T20:01:00Z

示例

正常返回示例

JSON格式

{
  "EndTime": "2019-12-10T20:01:00Z",
  "StartTime": "2019-12-10T20:00:00Z",
  "RequestId": "A666D44F-19D6-490E-97CF-1A64AB962C57",
  "DomainName": "example.com",
  "DataInterval": "60",
  "RealTimeTrafficDataPerInterval": {
    "DataModule": [
      {
        "Value": "0",
        "TimeStamp": "2019-12-10T20:01:00Z"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	MissingParameter	StartTime and EndTime can not be single.	开始时间与结束时间均为必填。
400	InvalidStartTime.Malformed	The specified value of parameter StartTime is malformed.	开始时间格式错误。日期格式请参考所调用API的帮助文档说明。
400	InvalidEndTime.Malformed	The specified value of parameter EndTime is malformed.	参数EndTime格式错误。
400	InvalidEndTime.Mismatch	Specified EndTime does not match the specified StartTime.	指定的EndTime与StartTime不匹配，StartTime应早于EndTime。
400	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.	开始时间设置错误，请检查更新后重试。
400	InvalidDomainName.Overlimit	Too many DomainNames are specified.	指定的域名数量超过了API的限制。
400	InvalidInterval.Malformed	Specified Interval is malformed.	时间粒度格式不规范。

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

变更历史

变更时间	变更内容概要	操作
2023-06-13	OpenAPI 错误码发生变更	查看变更详情