调用DescribeCasterProgram查询导播台节目单_视频直播(LIVE)-阿里云帮助中心

使用说明

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

QPS限制

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

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeCasterProgram	系统规定参数。取值：DescribeCasterProgram。
CasterId	String	是	LIVEPRODUCER_POST-cn-0pp1czt****	导播台ID。如果您通过CreateCaster接口创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。
EpisodeId	String	否	1872639A-F203-4EC5-8E43-CB92E68F****	节目ID。
EpisodeType	String	否	Resource	节点类型。取值： Resource：视频源。 Component：组件。
StartTime	String	否	2016-06-29T09:00:00Z	起始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
EndTime	String	否	2016-06-29T10:00:00Z	结束时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
PageNum	Integer	否	5	页码。
PageSize	Integer	否	10	每页节目数量。
Status	Integer	否	0	节目状态。取值： 0：未播放。 1：播放中。 2：播放完毕。

返回数据

名称	类型	示例值	描述
CasterId	String	LIVEPRODUCER_POST-cn-0pp1czt****	导播台ID。
Episodes	Array of Episode		节点列表。
Episode
ComponentIds	Array of String	["1872639A-F203-4EC5-8E43-CB929282****" ]	组件列表。
EndTime	String	2016-06-29T10:02:00Z	结束时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
EpisodeId	String	1872639A-F203-4EC5-8E43-CB92E68F****	节目ID。
EpisodeName	String	program_name_1	节目名称。
EpisodeType	String	Resource	节点类型。取值： Resource：视频源。 Component：组件。
ResourceId	String	1872639A-F203-4EC5-8E43-CB92E837****	视频源ID。
StartTime	String	2016-06-29T09:00:00Z	起始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
Status	Integer	0	节目状态。
SwitchType	String	TimeFirst	切换策略。取值： TimeFirst：时间优先，直播节目只允许采用时间优先。 ContentFirst：内容优先。
ProgramEffect	Integer	1	启用标志。 0：不启用。 1：启用。
ProgramName	String	programs_name	节目单名称。
RequestId	String	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8	请求ID。
Total	Integer	1	总记录数。

示例

请求示例

https://live.aliyuncs.com/?Action=DescribeCasterProgram
&CasterId=LIVEPRODUCER_POST-cn-0pp1czt****
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<DescribeCasterProgramResponse>
<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
<ProgramId>1872639A-F203-4EC5-8E43-CB92E68F****</ProgramId>
<ProgramName>programs_name</ProgramName>
<ProgramEffect>1</ProgramEffect>
<Episodes>
    <EpisodeId>1872639A-F203-4EC5-8E43-CB92E68F****</EpisodeId>
    <EpisodeType>Resource</EpisodeType>
    <EpisodeName>program_name_1</EpisodeName>
    <ResourceId>1872639A-F203-4EC5-8E43-CB92E837****</ResourceId>
    <ComponentIds>1872639A-F203-4EC5-8E43-CB929282****</ComponentIds>
    <StartTime>2016-06-29T09:00:00Z</StartTime>
    <EndTime>2016-06-29T10:02:00Z</EndTime>
    <Duration>120</Duration>
    <SwitchType>TimeFirst</SwitchType>
</Episodes>
<Episodes>
    <EpisodeId>1872639A-F203-4EC5-8E43-CB92E687****</EpisodeId>
    <EpisodeType>Component</EpisodeType>
    <ComponentIds>1872639A-F203-4EC5-8E43-CB625364****</ComponentIds>
    <StartTime>2016-06-29T19:02:00Z</StartTime>
    <EndTime>2016-06-29T19:04:00Z</EndTime>
</Episodes>
</DescribeCasterProgramResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "DescribeCasterProgramResponse" : {
    "RequestId" : "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
    "ProgramId" : "1872639A-F203-4EC5-8E43-CB92E68F****",
    "ProgramName" : "programs_name",
    "ProgramEffect" : 1,
    "Episodes" : [ {
      "EpisodeId" : "1872639A-F203-4EC5-8E43-CB92E68F****",
      "EpisodeType" : "Resource",
      "EpisodeName" : "program_name_1",
      "ResourceId" : "1872639A-F203-4EC5-8E43-CB92E837****",
      "ComponentIds" : "1872639A-F203-4EC5-8E43-CB929282****",
      "StartTime" : "2016-06-29T09:00:00Z",
      "EndTime" : "2016-06-29T10:02:00Z",
      "Duration" : 120,
      "SwitchType" : "TimeFirst"
    }, {
      "EpisodeId" : "1872639A-F203-4EC5-8E43-CB92E687****",
      "EpisodeType" : "Component",
      "ComponentIds" : "1872639A-F203-4EC5-8E43-CB625364****",
      "StartTime" : "2016-06-29T19:02:00Z",
      "EndTime" : "2016-06-29T19:04:00Z"
    } ]
  }
}

错误码

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