DescribeLiveDelayedStreamingUsage - 查询延播时长数据

调用DescribeLiveDelayedStreamingUsage查询延播时长用量数据。

接口说明

  • 查询用户延播服务用量数据,默认粒度为 1 小时粒度。
  • 最大查询时间跨度:31 天。
  • 最小查询时间粒度:1 小时。
  • 最大查询时间范围:31 天。

QPS 限制

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
live:DescribeLiveDelayedStreamingUsageget
*Domain
acs:cdn:*:{#accountId}:domain/{#DomainName}

请求参数

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

需要查询的主播流域名。

  • 支持单个或批量域名查询。批量查询时多个域名用英文逗号(,)分隔。
  • 若参数为空,默认返回所有直播域名合并后的数据。
example.com
StartTimestring

获取数据起始时间点,日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为:YYYY-MM-DDThh:mm:ssZ,默认返回近七天的数据。

2022-10-10T20:00:00Z
EndTimestring

结束时间需大于起始时间,时间跨度≤10 小时;日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为:YYYY-MM-DDThh:mm:ssZ。

2022-10-10T21:00:00Z
StreamNamestring

流名,多个流名使用逗号(半角)分隔,默认为所有流名数据聚合输出。

liveStream****
Regionstring

查询不同直播中心, 支持批量地区查询,多个地区用逗号(半角)分隔。取值:

  • cn-beijing:北京
  • cn-shanghai:上海
  • cn-shenzhen:深圳
  • cn-qingdao:青岛
  • ap-southeast-1:新加坡
  • eu-central-1:德国
  • ap-northeast-1:东京
  • ap-southeast-5:雅加达

不传值时默认为所有区域数据聚合输出。

cn-shanghai
SplitBystring

分组键,若参数为空,则聚合输出用户数据,取值:

  • domain:域名。如果此参数 Split(分组键)取值为 domain 时,返回参数 Domain 才生效。
  • region:直播中心地域。如果此参数 Split(分组键)取值为 region 时,返回参数 Region 才生效。
  • stream:流名。如果此参数 Split(分组键)取值为 stream 时,返回参数 stream 才生效。
说明 当分组键对应的参数不为空时才可以查询,否则返回错误。例如:当 DomainName 为空时不可以指定 domain 为分组键。
domain
Intervalstring

查询数据的时间粒度。单位:秒。取值:

  • 300
  • 3600
  • 86400

不传或传值不支持时,使用默认值 3600 秒。

3600

返回参数

名称类型描述示例值
object

返回数据。

DelayDataarray<object>

延播时长用量数据。

DelayDataItemobject

延播时长用量数据。

DomainNamestring

用量域名,SplitBy 指定 domain 时,分组输出。

example.com
Durationlong

延播用量。

84
Regionstring

直播中心,SplitBy 指定 region 时,分组输出。

cn-shanghai
StreamNamestring

流名,SplitBy 指定 stream 时,分组输出。

liveStream****
TimeStampstring

时间片起始时刻。

2022-10-10T20:00:00Z
EndTimestring

结束时间。

2022-10-10T21:00:00Z
RequestIdstring

该条任务请求 ID。

4B460F8B-993C-4F48-B98A-91081******
StartTimestring

起始时间。

2022-10-10T20:00:00Z

示例

正常返回示例

JSON格式

{
  "DelayData": {
    "DelayDataItem": [
      {
        "DomainName": "example.com",
        "Duration": 84,
        "Region": "cn-shanghai",
        "StreamName": "liveStream****",
        "TimeStamp": "2022-10-10T20:00:00Z"
      }
    ]
  },
  "EndTime": "2022-10-10T21:00:00Z",
  "RequestId": "4B460F8B-993C-4F48-B98A-91081******",
  "StartTime": "2022-10-10T20:00:00Z"
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameterInvalidParameter.-
400InvalidStartTime.MalformedThe specified StartTime parameter is invalid.-
400InvalidEndTime.MalformedThe specified EndTime is invalid.-
400InvalidStartTime.ValueNotSupportedThe StartTime cannot exceed 31 days before the current time.-
400InvalidParameterThe specified parameter is invalid.参数错误,请依据API文档,核对需要输入的参数
400InvalidTime.MalformedSpecified Time is malformed.制定时间错误,请您确认该制定时间是否正确。
400InvalidEndTime.MismatchSpecified end time does not math the specified start time.结束时间与开始时间不匹配,请您确认时间的匹配度。
400InvalidTimeSpanThe time span exceeds the limit.时间跨度超过限制,请参照接口文档,配置合理查询跨度。
400LiveServiceNotFound%s-

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

变更历史

变更时间变更内容概要操作
暂无变更历史