DescribeVodDomainUsageData - 查询流量带宽用量 - 视频点播

调用本接口查询加速流量或带宽用量数据。

接口说明

说明

目前服务地址仅支持：华东 2（上海）。

支持批量域名查询，多个域名用逗号半角（,）分隔,最多可以一次查询 100 个域名。如果为空则返回账号下所有域名的数据。

最长可查询近 1 年的数据，单次查询跨度最长为 3 个月，查询时间为 1-3 天时，数据按小时粒度返回，查询时间大于 4 天，数据按天粒度返回。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
vod:DescribeVodDomainUsageData	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
DomainName	string	否	加速域名。若参数为空，默认返回所有加速域名合并后数据。支持批量查询，多个用半角逗号（,）分隔。	example.com
StartTime	string	是	获取数据起始时间点。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2015-12-10T10:20:00Z
EndTime	string	是	获取数据结束时间点，需晚于起始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2015-12-10T12:20:00Z
Field	string	是	数据类型。取值： bps：带宽。 traf：流量。	bps
Type	string	否	需要获取的用量类型。取值： static：静态。 dynamic：动态。 all：全部。	static
Area	string	否	地域代号。默认为 CN 中国大陆。取值： CN：中国大陆。 OverSeas：海外区域。	CN
Interval	string	否	强制指定获取指定时间粒度的数据，单位为秒。支持 300（5 分钟）、3600（1 小时）和 86400（1 天）。 Interval=300：最长可查询最近半年的数据，单次查询的时间跨度最长为 3 天。 Interval=3600 或 86400：最长可查询最近 1 年的数据。不指定 Interval：单次查询跨度最长为 1 个月。当查询时间为 1~3 天时，数据按小时粒度返回；当查询时间为 4 天及以上时，数据按天粒度返回。	300

返回参数

名称	类型	描述	示例值
	object
EndTime	string	结束时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2015-12-10T12:20:00Z
Type	string	数据类型。取值： bps：带宽。 traf：流量。	bps
StartTime	string	开始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2015-12-10T10:20:00Z
RequestId	string	请求 ID。	B955107D-E658-4E77-****-E0AC3D31693E
Area	string	用量区域。	CN
DomainName	string	加速域名信息。	example.com
DataInterval	string	每条记录的时间间隔。单位：秒。	300
UsageDataPerInterval	array<object>	流量或带宽用量数据。
DataModule	object
Value	string	流量或带宽用量。单位：bit/second。	2592.3920000000003
TimeStamp	string	时间片起始时刻。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2015-12-10T10:00:00Z

示例

正常返回示例

JSON格式

{
  "EndTime": "2015-12-10T12:20:00Z",
  "Type": "bps",
  "StartTime": "2015-12-10T10:20:00Z",
  "RequestId": "B955107D-E658-4E77-****-E0AC3D31693E",
  "Area": "CN",
  "DomainName": "example.com",
  "DataInterval": "300",
  "UsageDataPerInterval": {
    "DataModule": [
      {
        "Value": "2592.3920000000003",
        "TimeStamp": "2015-12-10T10:00:00Z"
      }
    ]
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-01-30	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 CDN service yet.	403	未开通 CDN 服务。
OperationDenied	Your CDN service is suspended.	403	CDN 服务已被停止。
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 参数错误。