Lists LiveChannels in a bucket. You can filter results by prefix and paginate with marker and max-keys.
Request syntax
GET /?live HTTP/1.1
Date: GMT date
Host: BucketName.oss-cn-hangzhou.aliyuncs.com
Authorization: SignatureValue
Request elements
|
Element |
Type |
Required |
Description |
|
marker |
String |
No |
The LiveChannel name from which to start listing. LiveChannels alphabetically after this value are returned. |
|
max-keys |
String |
No |
The maximum number of LiveChannels to return. Valid values: 1 to 1000 Default value: 100 |
|
prefix |
String |
No |
The prefix that returned LiveChannel names must contain. If specified, the response includes the prefix. |
For common request headers in ListLiveChannel requests such as Host and Date, see Common request headers.
Response elements
|
Element |
Type |
Description |
|
ListLiveChannelResult |
Container |
The container for the ListLiveChannel response. Child nodes: Prefix, Marker, MaxKeys, IsTruncated, NextMarker, and LiveChannel Parent nodes: none |
|
Prefix |
String |
The prefix that returned LiveChannel names contain. Child nodes: none Parent nodes: ListLiveChannelResult |
|
Marker |
String |
The LiveChannel name from which listing started. Child nodes: none Parent nodes: ListLiveChannelResult |
|
MaxKeys |
String |
The maximum number of LiveChannels in the response. Child nodes: none Parent nodes: ListLiveChannelResult |
|
IsTruncated |
String |
Indicates whether all results are returned.
Child nodes: none Parent nodes: ListLiveChannelResult |
|
NextMarker |
String |
If not all results are returned, this value indicates the marker for the next request. Child nodes: none Parent nodes: ListLiveChannelResult |
|
LiveChannel |
Container |
The container for each returned LiveChannel. Child nodes: Name, Description, Status, LastModified, PublishUrls, and PlayUrls Parent nodes: ListLiveChannelResult |
|
Name |
String |
The name of the LiveChannel. Child nodes: none Parent nodes: LiveChannel |
|
Description |
String |
The description of the LiveChannel. Child nodes: none Parent nodes: LiveChannel |
|
Status |
Enumerated string |
The status of the LiveChannel. Child nodes: none Parent nodes: LiveChannel Valid values:
|
|
LastModified |
String |
The last time the LiveChannel configuration was modified. Format: ISO 8601. Child nodes: none Parent nodes: LiveChannel |
|
PublishUrls |
Container |
The container for the stream ingest URL of the LiveChannel. Child nodes: Url Parent nodes: LiveChannel |
|
Url |
String |
The stream ingest URL of the LiveChannel. Child nodes: none Parent nodes: PublishUrls |
|
PlayUrls |
Container |
The container for the stream playback URL of the LiveChannel. Child nodes: Url Parent nodes: LiveChannel |
|
Url |
String |
The stream playback URL of the LiveChannel. Child nodes: none Parent nodes: PlayUrls |
For common response headers such as ETag and x-oss-request-id in ListLiveChannel responses, see Common response headers.
Examples
Sample request
GET /?live&max-keys=1 HTTP/1.1
Date: Thu, 25 Aug 2016 07:50:09 GMT
Host: test-bucket.oss-cn-hangzhou.aliyuncs.com
Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/oss/aliyun_v4_request,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218e
Sample response
HTTP/1.1 200
content-length: 656
server: AliyunOSS
connection: close
x-oss-request-id: 57BEA331B92475920B00****
date: Thu, 25 Aug 2016 07:50:09 GMT
content-type: application/xml
<?xml version="1.0" encoding="UTF-8"?>
<ListLiveChannelResult>
<Prefix></Prefix>
<Marker></Marker>
<MaxKeys>1</MaxKeys>
<IsTruncated>true</IsTruncated>
<NextMarker>channel-0</NextMarker>
<LiveChannel>
<Name>channel-0</Name>
<Description></Description>
<Status>disabled</Status>
<LastModified>2016-07-30T01:54:21.000Z</LastModified>
<PublishUrls>
<Url>rtmp://test-bucket.oss-cn-hangzhou.aliyuncs.com/live/channel-0</Url>
</PublishUrls>
<PlayUrls>
<Url>http://test-bucket.oss-cn-hangzhou.aliyuncs.com/channel-0/playlist.m3u8</Url>
</PlayUrls>
</LiveChannel>
</ListLiveChannelResult>