ListPrograms - 列举频道组装节目-智能媒体服务(IMS)-阿里云帮助中心

接口说明

调用 ListPrograms 接口列举节目。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ice:ListPrograms

none

*全部资源

*

无

请求语法

POST / HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
ProgramName	string	否	节目名称。	program1
ChannelName	string	是	频道名称	MyChannel
PageNo	string	否	分页的页码。默认值：1。	1
PageSize	string	否	分页大小，每页显示条数。默认值为 20，最大值为 100。	10
SortBy	string	否	排序，按 CreateTime 排序，默认是 desc。 asc - 正序 desc - 倒序	desc

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID	xxx-xxxx-xxxxx-xxxx
TotalCount	integer	符合要求的节目总数。	100
Programs	array	节目列表。
	ChannelAssemblyProgram	节目信息。
PageNo	integer	分页的页码。默认值：1。	1
PageSize	integer	单页数据个数，默认为 20，最大 100。	10

示例

正常返回示例

JSON格式

{
  "RequestId": "xxx-xxxx-xxxxx-xxxx",
  "TotalCount": 100,
  "Programs": [
    {
      "GmtCreate": "2024-04-02T00:58:19Z\n",
      "ChannelName": "MyChannel",
      "SourceLocationName": "MySourceLocation",
      "AdBreaks": [
        {
          "TimeSignalSettings": "{\"segmentationEventID\":0,\"segmentationUPIDType\":14,\"segmentationUPID\":\"upid\",\"segmentationTypeID\":48,\"segmentNumber\":0,\"segmentsExpected\":0,\"subSegmentNumber\":1,\"subSegmentsExpected\":0}\n",
          "OffsetMillis": 1000,
          "ChannelName": "MyChannel",
          "SourceLocationName": "MySourceLocation",
          "SpliceInsertSettings": "{\"AvailNumber\":0,\"AvailExpected\":0,\"SpliceEventID\":1,\"UniqueProgramID\":0}\n",
          "SourceName": "MyAdSource",
          "ProgramName": "program_name\n",
          "MessageType": "SPLICE_INSERT"
        }
      ],
      "SourceType": "vodSource",
      "Transition": "{\"Type\": \"RELATIVE\", \"RelativePosition\": \"AFTER_PROGRAM\", \"RelativeProgram\": \"program2\"}\n",
      "GmtModified": "2024-04-02T00:58:19Z\n",
      "SourceName": "MySource",
      "ClipRange": "{StartOffsetMillis: 213123, EndOffsetMillis: 213134}\n",
      "Arn": "acs:ims:mediaweaver:::program/myChannel/MyProgram\n",
      "ProgramName": "program1"
    }
  ],
  "PageNo": 1,
  "PageSize": 10
}

错误码

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

变更历史

更多信息，参考变更详情。