ListChannels API Overview for MediaWeaver - Intelligent Media Services - Alibaba Cloud - Intelligent Media Services

Operation description

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

none

*All Resource

*

None

Request syntax

POST / HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ChannelName	string	No	The name of the channel.	MyChannel
ChannelTier	string	No	The tier of the channel. Valid values: basic and standard.	basic
PlaybackMode	string	No	The playback mode. Valid values: loop and linear.	loop
State	integer	No	The channel status. Valid values: 0 (stopped) and 1 (started).	0
PageNo	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 10.	20
SortByModifiedTime	string	No	The sort order by modification time. Valid values: asc and desc.	desc
SortBy	string	No	The sort order by creation time. Valid values: asc and desc.	asc

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	Request ID.	xxx-xxxx-xxxxx-xxxx
TotalCount	integer	The total number of channels returned.	180
PageSize	integer	The number of entries per page. Valid values: 1 to 100. Default value: 10.	10
PageNo	integer	The page number. Default value: 1.	1
ChannelList	array	The channels.
	ChannelAssemblyChannel	The channel information.

Examples

Success response

JSON format

{
  "RequestId": "xxx-xxxx-xxxxx-xxxx",
  "TotalCount": 180,
  "PageSize": 10,
  "PageNo": 1,
  "ChannelList": [
    {
      "FillerSourceName": "MySource",
      "FillerSourceLocationName": "MySourceLocation",
      "GmtCreate": "2024-01-15T03:44:16Z\n",
      "ChannelName": "MyChannel",
      "ChannelTier": "basic",
      "AccessToken": "xxxxx",
      "State": 0,
      "GmtModified": "2024-09-01T10:09Z\n",
      "Arn": "acs:ims:mediaweaver:::channel/myChannel\n",
      "PlaybackMode": "loop",
      "OutPutConfigList": [
        {
          "ManifestName": "index1",
          "ChannelName": "MyChannel",
          "Format": "hls",
          "PlaybackUrl": "https://xxxxx.com/xxx.m3u8\n",
          "ManifestSettings": "{\"WindowDuration\": 60,\"AdMarkType\":\"Daterange\"}\n",
          "SourceGroupName": "group1"
        }
      ],
      "AccessPolicy": true
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.