调用ListPlaylistItems查询指定节目单下的节目单项。
使用说明
先通过AddPlaylistItems接口添加节目单项,再调用本接口查询指定节目单下的节目单项。
QPS限制
本接口的单用户QPS限制为10次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListPlaylistItems |
系统规定参数。取值: ListPlaylistItems。 |
ProgramId | String | 是 | 445409ec-7eaa-461d-8f29-4bec2eb9**** |
节目单ID。如果您通过AddPlaylistItems接口添加节目单项,请查看AddPlaylistItems接口调用返回的参数ProgramId值。 |
RegionId | String | 否 | cn-shanghai |
地域ID。 |
ProgramItemIds | String | 否 | c10f3d63-eacf-4fbf-bd48-a07a6ba7****,c09f3d63-eacf-4fbf-bd48-a07a6ba7**** |
节目单项ID列表。用英文逗号(,)隔开。 如果传该参数,则只返回指定节目单项的信息。若不传,则返回该节目单所有节目单项的信息。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
ProgramItems | Array of ProgramItem |
节目单列表。 |
|
Index | Integer | 1 |
编排索引。 |
ProgramId | String | 445409ec-7eaa-461d-8f29-4bec2eb9**** |
节目单ID。可作为编辑节目单,删除节目单,查询节目单,启动节目单,停止节目单的请求参数。 |
ProgramItemId | String | c10f3d63-eacf-4fbf-bd48-a07a6ba7**** |
节目单项ID。 |
ProgramItemName | String | playlistItem1 |
节目单项名称。 |
ResourceType | String | vod |
资源类型。 |
ResourceValue | String | asdfasdf8as9df8sa9df89**** |
资源ID。 |
RequestId | String | 5c6a2a0d-f228-4a64-af62-20e91b9**** |
请求ID。 |
Total | Integer | 1 |
节目单项数量。 |
示例
请求示例
http(s)://live.aliyuncs.com/?Action=ListPlaylistItems
&ProgramId=445409ec-7eaa-461d-8f29-4bec2eb9****
&<公共请求参数>
正常返回示例
XML
格式
<ListPlaylistItemsResponse>
<RequestId>5c6a2a0d-f228-4a64-af62-20e91b9****</RequestId>
<ProgramItems>
<ProgramItemName>playlistItem1</ProgramItemName>
<ResourceValue>asdfasdf8as9df8sa9df89****</ResourceValue>
<ProgramItemId>c10f3d63-eacf-4fbf-bd48-a07a6ba7****</ProgramItemId>
<Index>1</Index>
<ResourceType>vod</ResourceType>
<ProgramId>445409ec-7eaa-461d-8f29-4bec2eb9****</ProgramId>
</ProgramItems>
<Total>1</Total>
</ListPlaylistItemsResponse>
JSON
格式
{
"ListPlaylistItemsResponse": {
"RequestId": "5c6a2a0d-f228-4a64-af62-20e91b9****",
"ProgramItems": {
"ProgramItemName": "playlistItem1",
"ResourceValue": "asdfasdf8as9df8sa9df89****",
"ProgramItemId": "c10f3d63-eacf-4fbf-bd48-a07a6ba7****",
"Index": 1,
"ResourceType": "vod",
"ProgramId": "445409ec-7eaa-461d-8f29-4bec2eb9****"
},
"Total": 1
}
}
错误码
访问错误中心查看更多错误码。