ListLivePackageChannels API Overview - Intelligent Media Services - Alibaba Cloud - Intelligent Media Services

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.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ice:ListLivePackageChannels

list

*All Resource

*

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	integer	No	The page number. Default value: 1.	1
PageSize	integer	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: asc desc Valid values: asc : asc desc : desc	desc

Response elements

Element	Type	Description	Example
	object	Schema of Response
LivePackageChannels	array<object>	The live package channels.
	array<object>	LivePackageChannelItemType
ChannelName	string	The channel name.	ch3
CreateTime	string	The time when the channel was created.	2023-04-01T12:00:00Z
Description	string	The channel description.	Test Channel
GroupName	string	The channel group name.	channel-group-1
IngestEndpoints	array<object>	The ingest endpoints.
	object	The information about the ingest endpoint.
Id	string	The ingest endpoint ID.	ingest1
Password	string	The password.	2F9e9******18b569c8
Url	string	The ingest endpoint URL.	http://xxx-1.packagepush-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest
Username	string	The username.	us12******das
LastModified	string	The time when the channel was last modified.	2023-04-01T12:00:00Z
Protocol	string	The ingest protocol. Only HLS is supported.	HLS
SegmentCount	integer	The number of M3U8 segments.	3
SegmentDuration	integer	The segment duration.	5
PageNo	integer	The page number.	1
PageSize	integer	The number of entries per page. Valid values: 1 to 100. Default value: 10.	10
RequestId	string	The request ID.	RequestId sample value
SortBy	string	The sort order. Valid values: asc and desc (default).	asc/desc
TotalCount	integer	The total number of entries returned.	15

Examples

Success response

JSON format

{
  "LivePackageChannels": [
    {
      "ChannelName": "ch3",
      "CreateTime": "2023-04-01T12:00:00Z\n",
      "Description": "Test Channel",
      "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 example value",
  "SortBy": "asc/desc",
  "TotalCount": 15
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.