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:DescribeDomainUsageDataget
  • 全部资源
    *

请求参数

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

直播域名。

  • 支持单个或批量域名查询。批量查询时多个域名用英文逗号(,)分隔。

  • 若参数为空,默认返回所有直播域名合并后的数据。

example.com
StartTimestring

起始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2015-12-10T20:00:00Z
EndTimestring

结束时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

需大于起始时间,且与起始时间相差不能超过 31 天。

2015-12-10T21:00:00Z
Typestring

需要获取的用量类型。

Field 取值为 bpstraf 时,该参数取值范围:

  • rts:RTS 带宽或流量。
  • quic:QUIC 带宽或流量。
  • all:全部。

Field 取值为req_trafreq_bps 时,该参数取值范围:

  • push:推流带宽或流量。
  • push_proxy:转推带宽或流量。
all
Fieldstring

查询用量的数据类型。取值:

  • bps:播放带宽。

  • traf:流量。

  • req_traf:当 Type 为 push 时,为推流流量,当 Type 为 push_proxy 时,为转推流量。

  • req_bps:当 Type 为 push 时,为推流带宽,当 Type 为 push_proxy 时,为转推带宽。

traf
Areastring

区域代号。支持:

  • CN:中国内地。
  • OverSeas:海外大区。
  • AP1:亚太 1 区。
  • AP2:亚太 2 区。
  • AP3:亚太 3 区。
  • NA:北美。
  • SA:南美。
  • EU:欧洲。
  • MEAA:中东非洲。
  • all:全部。
说明 不传值则默认为中国内地。海外大区说明:- 亚太 1 区:中国香港地区、中国澳门地区、中国台湾地区、日本以及东南亚除越南和印尼之外的国家。- 亚太 2 区:印尼、韩国、越南。- 亚太 3 区:澳大利亚、新西兰。北美:美国、加拿大。- 南美:巴西。- 欧洲:乌克兰、英国、法国、荷兰、西班牙、意大利、瑞典、德国。- 中东非洲:南非、阿曼、阿联酋、科威特。
CN
DataProtocolstring

需要获取的数据的协议。取值:

  • http:HTTP 协议。

  • https:HTTPS 协议。

  • quic:QUIC 协议。

  • all(默认):以上全部协议。

all
Intervalstring

强制指定获取指定时间粒度的数据,单位为秒。支持 300(5 分钟)、3600(1 小时)和 86400(1 天)。

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

返回参数

名称类型描述示例值
object
EndTimestring

结束时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2015-12-10T21:00Z
Typestring

用量类型。

all
StartTimestring

开始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2015-12-10T20:00Z
RequestIdstring

请求 ID。

B955107D-E658-4E77-B913-E0AC3D31693E
Areastring

用量区域。

CN
DomainNamestring

直播域名。

example.com
DataIntervalstring

每条记录的时间间隔。单位:秒。

300
UsageDataPerIntervalarray<object>

每条记录的流量数据。

DataModuleobject
Valuestring

用量。

  • 当 Field 为 traf 或 req_traf 时单位是字节(Byte)。

  • 当 Field 为 bps 或 req_bps 时单位是 bps。

  • 当 Field 为 acc 时单位是次数。

423304182
TimeStampstring

时间片起始时刻。格式为: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错误码错误信息描述
400InvaildParameterInvalid Parameter请求参数非法
400InvalidStartTime.MalformedSpecified StartTime is malformed.StartTime参数错误,请您确认该StartTime参数是否正确。
400InvalidEndTime.MalformedSpecified EndTime is malformed.结束时间错误,请您确认结束时间是否正确。
400InvalidStartTime.ValueNotSupportedThe specified value of parameter StartTime is not supported.传入的StartTime参数不支持。
400InvalidTime.MalformedSpecified Time is malformed.制定时间错误,请您确认该制定时间是否正确。
400InvalidParameterFieldThe specified Field is invalid.Field参数错误,请确认后输入
400InvalidParameterTypeThe specified Type is invalid.Type参数错误,请确认后输入
400InvalidEndTime.MismatchSpecified end time does not math the specified start time.结束时间与开始时间不匹配,请您确认时间的匹配度。
400InvalidTimeSpanThe time span exceeds the limit.时间跨度超过限制,请参照接口文档,配置合理查询跨度。

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

变更历史

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

特殊错误码

错误代码描述HTTP 状态码语义
ThrottlingRequest was denied due to request throttling.503请求被流量控制限制
IllegalOperationIllegal domain, operation is not permitted.403非法域名,无法操作
OperationDeniedYour account does not open Live service yet.403未开通 Live 服务
OperationDeniedYour Live service is suspended.403Live 服务已被停止
InvalidDomain.NotFoundThe domain provided does not belong to you.404域名不存在或不属于当前用户
InvalidDomain.OfflineThe domain provided is offline.404域名已下线
ServiceBusyThe specified Domain is configuring, please retry later.403域名正在配置中,请稍后再试
InvalidDomain.Configure_failedFailed to configure the provided domain.500域名配置失败
InvalidParameterInvalid Parameter.400参数错误
InvalidParameterProductInvalid Parameter Product.400Product 参数错误
InvalidParameterAreaInvalid Parameter Area.400Area 参数错误
InvalidParameterFieldInvalid Parameter Field.400Field 参数错误
InvalidParameterStartTimeInvalid Parameter StartTime.400StartTime 参数错误
InvalidParameterEndTimeInvalid Parameter EndTime.400EndTime 参数错误
InvalidTimeRangeStartTime and EndTime range should less than 1 month.400EndTime 和 StartTime 差值不能超过 31 天
InvalidParameterIntervalInvalid Parameter Interval.400Interval 参数错误