Queries live package channels by channel group and keyword. Paging and sorting are supported.
Operation description
Usage notes
This API operation allows you to query live package channels by GroupName and Keyword. Keyword is optional. You can sort the channels by creation time in ascending or descending order and paginate the results. This facilitates the management of channels and retrieval of channel information.
- GroupName is required to specify the channel group to which the channel belongs.
- Keyword supports fuzzy match of channel names or descriptions, which helps quickly filter desired channels.
- PageNo and PageSize can help control the paging of returned results to facilitate batch processing of data.
- SortBy allows you to customize how the results are sorted. By default, the results are sorted in descending order.
RequestId in the response is used for subsequent troubleshooting. TotalCount indicates the total number of channels that meet the conditions.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ice:ListLivePackageChannels | list | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| GroupName | string | Yes | The channel group name. | channel-group-1 |
| Keyword | string | No | The channel name or description. Fuzzy match is supported. | group-1 |
| PageNo | long | No | The page number. Default value: 1. | 1 |
| PageSize | long | No | The number of entries per page. Default value: 10. | 10 |
| SortBy | string | No | The sort order by creation time. Default value: desc. Valid values:
| desc |
Response parameters
Examples
Sample success responses
JSONformat
{
"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": "",
"SortBy": "asc/desc",
"TotalCount": 15
}Error codes
For a list of error codes, visit the Service error codes.