ListLivePackageChannels - 查询实时打包频道

更新时间:
复制 MD 格式

按频道组与关键词查询实时打包频道列表,支持分页和排序。

接口说明

请求说明

该接口允许用户根据指定的 GroupName 和可选的 Keyword 查询实时打包频道列表。结果可以按创建时间等进行升序或降序排序,并支持分页查询,以便于管理和检索大量频道信息。

  • GroupName 是必填项,用于指定频道所在的频道组。

  • Keyword 支持模糊匹配频道名称或描述,有助于快速过滤所需频道。

  • PageNo 和 PageSize 参数可以帮助控制返回结果的分页,方便分批处理数据。

  • SortBy 参数允许用户自定义结果排序方式,默认按降序排列。

注意检查返回的 RequestId 用于后续问题排查,同时关注 TotalCount 了解符合条件的总频道数量。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

ice:ListLivePackageChannels

list

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

GroupName

string

是

频道组名称

channel-group-1

Keyword

string

否

频道名称或描述,支持模糊匹配

group-1

PageNo

integer

否

页码,默认值:1

1

PageSize

integer

否

分页大小,默认值 10

10

SortBy

string

否

按创建时间升降排序。默认 desc,降序

枚举值:

  • asc :

    asc

  • desc :

    desc

desc

返回参数

名称

类型

描述

示例值

object

Schema of Response

LivePackageChannels

array<object>

实时打包频道列表

array<object>

LivePackageChannelItemType

ChannelName

string

频道名称

ch3

CreateTime

string

创建时间

2023-04-01T12:00:00Z

Description

string

频道描述

测试频道

GroupName

string

频道组名称

channel-group-1

IngestEndpoints

array<object>

输入端点数组

object

输入端点

Id

string

输入端点 ID

ingest1

Password

string

密码

2F9e9******18b569c8

Url

string

输入端点 URL

http://xxx-1.packagepush-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest

Username

string

用户名

us12******das

LastModified

string

最后修改时间

2023-04-01T12:00:00Z

Protocol

string

输入协议,HLS

HLS

SegmentCount

integer

输入流 m3u8 切片个数

3

SegmentDuration

integer

输入流切片时长

5

PageNo

integer

页码。

1

PageSize

integer

每页大小,[1, 100],不传默认为 10

10

RequestId

string

请求的唯一标识

RequestId的示例值

SortBy

string

排序方式,asc,desc(默认)

asc/desc

TotalCount

integer

总记录数

15

示例

正常返回示例

JSON格式

{
  "LivePackageChannels": [
    {
      "ChannelName": "ch3",
      "CreateTime": "2023-04-01T12:00:00Z\n",
      "Description": "测试频道",
      "GroupName": "channel-group-1",
      "IngestEndpoints": [
        {
          "Id": "ingest1",
          "Password": "2F9e9******18b569c8",
          "Url": "http://xxx-1.packagepush-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest",
          "Username": "us12******das"
        }
      ],
      "LastModified": "2023-04-01T12:00:00Z",
      "Protocol": "HLS",
      "SegmentCount": 3,
      "SegmentDuration": 5
    }
  ],
  "PageNo": 1,
  "PageSize": 10,
  "RequestId": "RequestId的示例值",
  "SortBy": "asc/desc",
  "TotalCount": 15
}

错误码

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

变更历史

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