DescribeCasterProgram - 查询导播台节目单

查询导播台节目单。

接口说明

调用本接口查询导播台节目单,本接口目前支持的节点类型为视频源和组件。

QPS 限制

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

调试

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

授权信息

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

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

请求参数

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

导播台 ID。

  • 如果您通过 CreateCaster 接口创建导播台,请查看 CreateCaster 接口调用返回的参数 CasterId 值。

  • 如果您通过直播控制台创建导播台,请通过直播控制台 > 导播台 > 云导播台页面查看。

说明 直播控制台云导播台页面导播台列表中的导播台名称即导播台 ID。
LIVEPRODUCER_POST-cn-0pp1czt****
EpisodeIdstring

节目 ID。

1872639A-F203-4EC5-8E43-CB92E68F****
EpisodeTypestring

节点类型。取值:

  • Resource:视频源。
  • Component:组件。
Resource
StartTimestring

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

2016-06-29T09:00:00Z
EndTimestring

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

2016-06-29T10:00:00Z
PageNuminteger

页码。

5
PageSizeinteger

每页节目数量。

10
Statusinteger

节目状态。 取值:

  • 0:未播放。
  • 1:播放中。
  • 2:播放完毕。
0

返回参数

名称类型描述示例值
object
CasterIdstring

导播台 ID。

LIVEPRODUCER_POST-cn-0pp1czt****
Episodesarray<object>

节点列表。

Episodeobject

节点列表。

ComponentIdsarray

组件列表。

ComponentIdstring

组件列表。

["1872639A-F203-4EC5-8E43-CB929282****" ]
EndTimestring

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

2016-06-29T10:02:00Z
EpisodeIdstring

节目 ID。

1872639A-F203-4EC5-8E43-CB92E68F****
EpisodeNamestring

节目名称。

program_name_1
EpisodeTypestring

节点类型。 取值:

  • Resource:视频源。
  • Component:组件。
Resource
ResourceIdstring

视频源 ID。

1872639A-F203-4EC5-8E43-CB92E837****
StartTimestring

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

2016-06-29T09:00:00Z
Statusinteger

节目状态。

0
SwitchTypestring

切换策略。取值:

  • TimeFirst:时间优先,直播节目只允许采用时间优先。
  • ContentFirst:内容优先。
TimeFirst
ProgramEffectinteger

启用标志。

  • 0:不启用 。
  • 1:启用。
1
ProgramNamestring

节目单名称。

programs_name
RequestIdstring

请求 ID。

16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
Totalinteger

总记录数。

1

示例

正常返回示例

JSON格式

{
  "CasterId": "LIVEPRODUCER_POST-cn-0pp1czt****",
  "Episodes": {
    "Episode": [
      {
        "ComponentIds": {
          "ComponentId": [
            "[\"1872639A-F203-4EC5-8E43-CB929282****\" ]"
          ]
        },
        "EndTime": "2016-06-29T10:02:00Z",
        "EpisodeId": "1872639A-F203-4EC5-8E43-CB92E68F****",
        "EpisodeName": "program_name_1",
        "EpisodeType": "Resource",
        "ResourceId": "1872639A-F203-4EC5-8E43-CB92E837****",
        "StartTime": "2016-06-29T09:00:00Z",
        "Status": 0,
        "SwitchType": "TimeFirst"
      }
    ]
  },
  "ProgramEffect": 1,
  "ProgramName": "programs_name",
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
  "Total": 1
}

错误码

HTTP status code错误码错误信息
400InvalidPageSize.Malformed%s
400InvalidPageNum.Malformed%s
400InvalidStartTime.Malformed%s
400InvalidEndTime.Malformed%s
400InvalidStatus.Malformed%s
400InvalidParameter.Malformed%s
400InvalidCasterId.Malformed%s
404InvalidCaster.NotFound%s
500InternalError%s

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

变更历史

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