Queries MediaLive channels.
Operation description
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:ListMediaLiveChannels | list | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| MaxResults | integer | No | The number of entries per page. Valid values: 1 to 100. Default value:
| 10 |
| Skip | integer | No | The number of entries to be skipped in the query. If the number of entries you attempt to skip exceeds the number of entries that meet the condition, an empty list is returned. | 20 |
| NextToken | string | No | The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken. | caeba0bbb2be03f84eb48b699f0a4883 |
| SortOrder | string | No | The sorting order of the channels by creation time. Default value: asc. Valid values: desc and asc. asc indicates the ascending order, and desc indicates the descending order. | desc |
| Keyword | string | No | The keyword of the query. You can perform a fuzzy search on channel ID or name. | 123 |
| States | string | No | The state of channels you want to query. You can separate multiple states with commas (,) in a JSON array. | ["IDLE","RUNNING"] |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "******11-DB8D-4A9A-875B-275798******",
"Channels": [
{
"ChannelId": "SEGK5KA6KYKAWQQH",
"Name": "mych",
"State": "IDLE",
"InputAttachments": [
{
"InputId": "SEGK5KA6KYKAWQQH",
"InputName": "myinput",
"LanguageName": "eng",
"AudioSelectors": [
{
"Name": "myselector",
"AudioLanguageSelection": {
"LanguageCode": "eng"
},
"AudioPidSelection": {
"Pid": 123
},
"AudioTrackSelection": [
{
"TrackId": 1
}
]
}
]
}
],
"OutputGroups": [
{
"Name": "group1",
"Type": "MediaPackage",
"Outputs": [
{
"Name": "output1",
"MediaType": 0,
"MediaPackageOutputSetting": {
"NameModifier": "480p",
"AudioGroupId": "audiogroup"
},
"VideoSettingName": "myVideo1",
"AudioSettingNames": [
"myAudio1"
]
}
],
"MediaPackageGroupSetting": {
"GroupName": "myPackageGroup",
"ChannelName": "myPackageChannel"
},
"MonitorUrl": "rtmp://xxx"
}
],
"AudioSettings": [
{
"Name": "zhuanfengzhuang",
"AudioSelectorName": "myselector",
"LanguageCode": "eng",
"LanguageName": "English",
"AudioCodec": "aac",
"AudioCodecSetting": {
"Profile": "AAC-LOW",
"Bitrate": 200000,
"SampleRate": 44100
}
}
],
"VideoSettings": [
{
"Name": "video1",
"Width": 1280,
"Height": 720,
"VideoCodec": "H264",
"VideoCodecSetting": {
"Rate": {
"Bitrate": 2500000,
"RateControlMode": "ABR",
"MaxBitrate": 6000000,
"BufferSize": 6000000
},
"Framerate": {
"FramerateControl": "SPECIFIED",
"FramerateNumerator": 25,
"FramerateDenominator": 1
},
"Gop": {
"GopSizeUnits": "FRAMES",
"GopSize": 90,
"BframesNum": 3
},
"CodecDetail": {
"Profile": "MAIN",
"Level": "H264_LEVEL_AUTO"
}
},
"VideoCodecType": "NORMAL"
}
],
"CreateTime": "2024-12-03T06:56:42Z",
"LastStartTime": "2024-12-03T06:56:42Z",
"LastStopTime": "2024-12-03T06:56:42Z"
}
],
"MaxResults": 10,
"NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
"TotalCount": 100
}Error codes
For a list of error codes, visit the Service error codes.