ListLivePackageChannelGroups API Reference - IMS - Alibaba Cloud - Intelligent Media Services

Operation description

Usage notes

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:ListLivePackageChannelGroups

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Keyword	string	No	The channel group name or description. Fuzzy match is supported.	channel-group
PageNo	integer	No	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 10.	10
SortBy	string	No	The sort order by creation time. Default value: desc.	desc

Response elements

Element	Type	Description	Example
	object	Schema of Response
LivePackageChannelGroups	array<object>	The channel groups returned.
	object	LivePackageChannelGroupItemType
CreateTime	string	The time when the channel group was created. It is in the `yyyy-MM-ddTHH:mm:ssZ` format and displayed in UTC.	2023-04-01T12:00:00Z
Description	string	The channel group description.	This is the description of the channel group.
GroupName	string	The channel group name.	testChannelGroup
LastModified	string	The time when the channel group was last modified. It is in the `yyyy-MM-ddTHH:mm:ssZ` format and displayed in UTC.	2023-04-02T12:00:00Z
OriginDomain	string	The origin domain.	origin.example.com
PageNo	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
RequestId	string	The request ID.	5D87B753-0250-5D9D-B248-D40C3271F864
SortBy	string	The sort order.	desc
TotalCount	integer	The total number of entries returned.	100

Examples

Success response

JSON format

{
  "LivePackageChannelGroups": [
    {
      "CreateTime": "2023-04-01T12:00:00Z",
      "Description": "This is the description for the channel group.",
      "GroupName": "testChannelGroup",
      "LastModified": "2023-04-02T12:00:00Z",
      "OriginDomain": "origin.example.com"
    }
  ],
  "PageNo": 1,
  "PageSize": 10,
  "RequestId": "5D87B753-0250-5D9D-B248-D40C3271F864",
  "SortBy": "desc",
  "TotalCount": 100
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.