DescribeDomainUsageData - 查询域名在特定计费区域的用量数据 - 视频直播

调用DescribeDomainUsageData查询域名在特定计费区域的用量数据。

接口说明

此接口支持批量域名查询，多个域名用英文逗号（,）分隔，最多一次可以查询 100 个域名。如果 DomainName 参数为空，则返回账号下所有域名的数据。
用量数据包括流量、带宽和请求数三类，单位分别为 Byte、bps 和次数。
如果不指定 Interval 参数，最长可查询近 1 年的数据，单次查询的最大时间跨度为 31 天。查询时间为 1~3 天，数据按小时粒度返回；查询时间大于 3 天，数据按天粒度返回。
指定 Interval 参数时，支持单次查询的时间跨度、对应的可查询历史数据时间范围和数据延迟如下：

时间粒度	单次查询的最大时间跨度	可查询历史数据时间范围	数据延迟
5 分钟	3 天	93 天	15 分钟
1 小时	31 天	186 天	4 小时
1 天	90 天	366 天	次日凌晨 4 点

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
live:DescribeDomainUsageData	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
DomainName	string	否	直播域名。支持单个或批量域名查询。批量查询时多个域名用英文逗号（,）分隔。若参数为空，默认返回所有直播域名合并后的数据。	example.com
StartTime	string	是	起始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2015-12-10T20:00:00Z
EndTime	string	是	结束时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。需大于起始时间，且与起始时间相差不能超过 31 天。	2015-12-10T21:00:00Z
Type	string	否	需要获取的用量类型。当 Field 取值为 bps 或 traf 时，该参数取值范围： rts：RTS 带宽或流量。 quic：QUIC 带宽或流量。 all：全部。当 Field 取值为req_traf或req_bps 时，该参数取值范围： push：推流带宽或流量。 push_proxy：转推带宽或流量。	all
Field	string	是	查询用量的数据类型。取值： bps：播放带宽。 traf：流量。 req_traf：当 Type 为 push 时，为推流流量，当 Type 为 push_proxy 时，为转推流量。 req_bps：当 Type 为 push 时，为推流带宽，当 Type 为 push_proxy 时，为转推带宽。	traf
Area	string	否	区域代号。支持： CN：中国内地。 OverSeas：海外大区。 AP1：亚太 1 区。 AP2：亚太 2 区。 AP3：亚太 3 区。 NA：北美。 SA：南美。 EU：欧洲。 MEAA：中东非洲。 all：全部。说明不传值则默认为中国内地。海外大区说明：- 亚太 1 区：中国香港地区、中国澳门地区、中国台湾地区、日本以及东南亚除越南和印尼之外的国家。- 亚太 2 区：印尼、韩国、越南。- 亚太 3 区：澳大利亚、新西兰。北美：美国、加拿大。- 南美：巴西。- 欧洲：乌克兰、英国、法国、荷兰、西班牙、意大利、瑞典、德国。- 中东非洲：南非、阿曼、阿联酋、科威特。	CN
DataProtocol	string	否	需要获取的数据的协议。取值： http：HTTP 协议。 https：HTTPS 协议。 quic：QUIC 协议。 all（默认）：以上全部协议。	all
Interval	string	否	强制指定获取指定时间粒度的数据，单位为秒。支持 300（5 分钟）、3600（1 小时）和 86400（1 天）。	300

说明接口查询 T 时刻数据时，T+N 时刻可获取到稳态数据，N 为 2 小时。
示例：当您查询 12 月 21 日下午 1 点钟数据，可在 12 月 21 日下午 3 点钟获取到 1 点及 1 点前的稳态数据。

返回参数

名称	类型	描述	示例值
	object
EndTime	string	结束时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2015-12-10T21:00Z
Type	string	用量类型。	all
StartTime	string	开始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2015-12-10T20:00Z
RequestId	string	请求 ID。	B955107D-E658-4E77-B913-E0AC3D31693E
Area	string	用量区域。	CN
DomainName	string	直播域名。	example.com
DataInterval	string	每条记录的时间间隔。单位：秒。	300
UsageDataPerInterval	array<object>	每条记录的流量数据。
DataModule	object
Value	string	用量。当 Field 为 traf 或 req_traf 时单位是字节（Byte）。当 Field 为 bps 或 req_bps 时单位是 bps。当 Field 为 acc 时单位是次数。	423304182
TimeStamp	string	时间片起始时刻。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2015-12-10T20:00:00Z

示例

正常返回示例

JSON格式

{
  "EndTime": "2015-12-10T21:00Z",
  "Type": "all",
  "StartTime": "2015-12-10T20:00Z",
  "RequestId": "B955107D-E658-4E77-B913-E0AC3D31693E",
  "Area": "CN",
  "DomainName": "example.com",
  "DataInterval": "300",
  "UsageDataPerInterval": {
    "DataModule": [
      {
        "Value": "423304182",
        "TimeStamp": "2015-12-10T20:00:00Z"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvaildParameter	Invalid Parameter	请求参数非法
400	InvalidStartTime.Malformed	Specified StartTime is malformed.	StartTime参数错误，请您确认该StartTime参数是否正确。
400	InvalidEndTime.Malformed	Specified EndTime is malformed.	结束时间错误，请您确认结束时间是否正确。
400	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.	传入的StartTime参数不支持。
400	InvalidTime.Malformed	Specified Time is malformed.	制定时间错误，请您确认该制定时间是否正确。
400	InvalidParameterField	The specified Field is invalid.	Field参数错误，请确认后输入
400	InvalidParameterType	The specified Type is invalid.	Type参数错误，请确认后输入
400	InvalidEndTime.Mismatch	Specified end time does not math the specified start time.	结束时间与开始时间不匹配，请您确认时间的匹配度。
400	InvalidTimeSpan	The time span exceeds the limit.	时间跨度超过限制，请参照接口文档，配置合理查询跨度。

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

变更历史

变更时间	变更内容概要	操作
2024-09-29	OpenAPI 描述信息更新、OpenAPI 错误码发生变更	查看变更详情
2023-07-27	OpenAPI 错误码发生变更	查看变更详情

特殊错误码

错误代码	描述	HTTP 状态码	语义
Throttling	Request was denied due to request throttling.	503	请求被流量控制限制
IllegalOperation	Illegal domain, operation is not permitted.	403	非法域名，无法操作
OperationDenied	Your account does not open Live service yet.	403	未开通 Live 服务
OperationDenied	Your Live service is suspended.	403	Live 服务已被停止
InvalidDomain.NotFound	The domain provided does not belong to you.	404	域名不存在或不属于当前用户
InvalidDomain.Offline	The domain provided is offline.	404	域名已下线
ServiceBusy	The specified Domain is configuring, please retry later.	403	域名正在配置中，请稍后再试
InvalidDomain.Configure_failed	Failed to configure the provided domain.	500	域名配置失败
InvalidParameter	Invalid Parameter.	400	参数错误
InvalidParameterProduct	Invalid Parameter Product.	400	Product 参数错误
InvalidParameterArea	Invalid Parameter Area.	400	Area 参数错误
InvalidParameterField	Invalid Parameter Field.	400	Field 参数错误
InvalidParameterStartTime	Invalid Parameter StartTime.	400	StartTime 参数错误
InvalidParameterEndTime	Invalid Parameter EndTime.	400	EndTime 参数错误
InvalidTimeRange	StartTime and EndTime range should less than 1 month.	400	EndTime 和 StartTime 差值不能超过 31 天
InvalidParameterInterval	Invalid Parameter Interval.	400	Interval 参数错误