全部產品
Search
文件中心

:ListLiveChannel

更新時間:Jun 19, 2024

ListLiveChannel介面用於列舉指定的LiveChannel。

請求文法

GET /?live HTTP/1.1
Date: GMT date
Host: BucketName.oss-cn-hangzhou.aliyuncs.com
Authorization: SignatureValue

請求元素

名稱

類型

是否必選

描述

Marker

字串

設定結果從marker之後按字母排序的第一個開始返回。

Max-keys

字串

限定此次返回LiveChannel的最大數。

取值:大於0小於等於1000

預設值:100

Prefix

字串

限定返回的LiveChannel必須以prefix作為首碼。使用prefix查詢時,返回的key中仍會包含prefix。

此介面還需要包含Host、Date等公用要求標頭。更多資訊,請參見公用要求標頭(Common Request Headers)

響應元素

名稱

類型

描述

ListLiveChannelResult

容器

儲存ListLiveChannel請求結果的容器。

子節點:Prefix、Marker、MaxKeys、IsTruncated、NextMarker、LiveChannel

父節點:無

Prefix

字串

本次查詢結果的開始首碼。

子節點:無

父節點:ListLiveChannelResult

Marker

字串

本次ListLiveChannel的起點。

子節點:無

父節點:ListLiveChannelResult

MaxKeys

字串

響應請求內返回結果的最大數目。

子節點:無

父節點:ListLiveChannelResult

IsTruncated

字串

是否已返回所有的結果。

  • true:表示本次請求已返回全部結果。

  • false:表示本次請求未返回全部結果。

子節點:無

父節點:ListLiveChannelResult

NextMarker

字串

如果本次沒有返回全部結果,響應請求中將包含NextMarker元素,用於標明接下來請求的Marker值。

子節點:無

父節點:ListLiveChannelResult

LiveChannel

容器

儲存返回每個LiveChannel資訊的容器。

子節點:Name、Description、Status、LastModified、PublishUrls、PlayUrls

父節點:ListLiveChannelResult

Name

字串

LiveChannel的名稱。

子節點:無

父節點:LiveChannel

Description

字串

LiveChannel的描述資訊。

子節點:無

父節點:LiveChannel

Status

枚舉字串

LiveChannel的狀態。

子節點:無

父節點:LiveChannel

有效值:

  • disabled:表示禁用LiveChannel。

  • enabled:表示啟用LiveChannel。

LastModified

字串

LiveChannel配置的最後修改時間。

格式:ISO8601

子節點:無

父節點:LiveChannel

PublishUrls

容器

儲存LiveChannel對應的推流地址的容器。

子節點:Url

父節點:LiveChannel

Url

字串

LiveChannel對應的推流地址。

子節點:無

父節點:PublishUrls

PlayUrls

容器

儲存LiveChannel對應的播放地址的容器。

子節點:Url

父節點:LiveChannel

Url

字串

LiveChannel對應的播放地址。

子節點:無

父節點:PlayUrls

此介面還包含ETag、x-oss-request-id等公用回應標頭。更多資訊,請參見公用回應標頭(Common Response Headers)

樣本

請求樣本

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: OSS qn6q**************:77Dv****************

返回樣本

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>