DescribeLiveProducerUsageData - 查询导播台用量数据

调用DescribeLiveProducerUsageData查询导播台用量数据。

接口说明

最小数据查询粒度为 1 小时;最大查询时间跨度为 31 天;支持历史最大查询时间范围为最近 90 天。

QPS 限制

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

live:DescribeLiveProducerUsageData

get

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

请求参数

名称

类型

必填

描述

示例值

RegionId

string

Region

string

域名所属地域。若参数为空,默认返回所有 Region 合并后数据,支持批量查询,多个 Region 用半角逗号(,)分隔。

cn-shanghai

DomainName

string

云导播播流域名。

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

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

example.com

Instance

string

查询实例。支持批量实例查询,多个实例用英文逗号(,)分隔。

说明

若参数为空,默认返回所有实例合并后数据。

a17d0184-462d-4630-b2a6-8c26dde2****

Type

string

导播类型。支持批量查询,多个类型用英文逗号(,)分隔。取值:

  • slidelive:播单型。

  • universal:通用型。

说明

若参数为空,默认返回所有导播类型合并后数据。

slidelive

SplitBy

string

分组键。可以指定 domain、region、 instance,、type 其中之一或多个, 多个使用英文逗号(,)分隔.。指定了 split 的字段将会被分组输出。

说明

若参数为空, 则只输出按照聚合后数据.

type

StartTime

string

开始时间。日期格式按照 ISO8601 表示法,并使用 UTC+0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

2018-09-30T16:00:00Z

EndTime

string

结束时间。日期格式按照 ISO8601 表示法,并使用 UTC+0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

说明

结束时间需大于起始时间。

2018-10-31T15:59:59Z

Interval

string

指定查询数据的时间粒度,支持 3600(1 小时)和 86400(1 天)的取值。单位:秒。

3600

app

string

播流所属应用名称。

liveApp****

返回参数

名称

类型

描述

示例值

object

BillProducerData

object

BillProducerDataItem

array

用户导播台用量数据。

object

DomainName

string

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

example.com

Instance

string

用量实例。SplitBy 指定为 instance 时,分组输出。

a17d0184-462d-4630-b2a6-8c26dde2****

OutputHdDuration

integer

高清分辨率时长,单位为分钟。

6000

OutputLdDuration

integer

流畅分辨率时长,单位为分钟。

1001

OutputSdDuration

integer

标准分辨率时长,单位为分钟。

500

Region

string

用量地区。SplitBy 指定为 region 时,分组输出。

cn-shanghai

TimeStamp

string

时间片起始时刻。

2018-09-30T00:00:00Z

TranHdDuration

integer

转码高清分辨率时长,单位为分钟。

6777

TranLdDuration

integer

转码流畅分辨率时长,单位为分钟。

111

TranSdDuration

integer

转码标准分辨率时长,单位为分钟。

666

Type

string

导播类型。SplitBy 指定为 type 时,分组输出。

slidelive

EndTime

string

结束时间。

2018-09-30T16:00:00Z

RequestId

string

请求 ID。

C370DAF1-C838-4288-A1A0-9A87633D248E

StartTime

string

开始时间。

2018-10-31T15:59:59Z

示例

正常返回示例

JSON格式

{
  "BillProducerData": {
    "BillProducerDataItem": [
      {
        "DomainName": "example.com",
        "Instance": "a17d0184-462d-4630-b2a6-8c26dde2****",
        "OutputHdDuration": 6000,
        "OutputLdDuration": 1001,
        "OutputSdDuration": 500,
        "Region": "cn-shanghai",
        "TimeStamp": "2018-09-30T00:00:00Z",
        "TranHdDuration": 6777,
        "TranLdDuration": 111,
        "TranSdDuration": 666,
        "Type": "slidelive"
      }
    ]
  },
  "EndTime": "2018-09-30T16:00:00Z",
  "RequestId": "C370DAF1-C838-4288-A1A0-9A87633D248E",
  "StartTime": "2018-10-31T15:59:59Z"
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidStartTime.Malformed Specified StartTime is malformed.
400 InvalidEndTime.Malformed Specified EndTime is malformed.
400 InvalidTime.Malformed Specified StartTime or EndTime is malformed.
400 InvalidEndTime.Mismatch Specified end time does not math the specified start time. 结束时间与开始时间不匹配,请您确认时间的匹配度。
400 InvalidTimeSpan The time span exceeds the limit. 时间跨度超过限制,请参照接口文档,配置合理查询跨度。
400 InvalidTime.ValueNotSupported Specified Time is malformed. 指定的时间无效。

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

变更历史

更多信息,参考变更详情