查詢域名在線流列表
調(diào)用DescribeLiveStreamsOnlineList查詢指定域名或指定域名下某個應(yīng)用的所有在線流信息。
使用說明
本接口目前支持以下幾種流類型:
- all:查詢所有流。
- raw:查詢原始流。
- trans:查詢轉(zhuǎn)碼流。
QPS限制
本接口的單用戶QPS限制為10000次/分鐘。超過限制,API調(diào)用會被限流,這可能會影響您的業(yè)務(wù),請合理調(diào)用。更多信息,請參見QPS限制。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數(shù)
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | DescribeLiveStreamsOnlineList | 系統(tǒng)規(guī)定參數(shù)。取值:DescribeLiveStreamsOnlineList。 |
DomainName | String | 是 | example.com | 主播流域名。 |
AppName | String | 否 | liveApp**** | 播流所屬應(yīng)用名稱。 |
StreamName | String | 否 | liveStream**** | 播流名稱,僅支持輸入單個StreamName。 |
OnlyStream | String | 否 | no | 是否只返回指定字段。取值:
|
PageSize | Integer | 否 | 1500 | 每頁大小。取值范圍:1~3000,默認值為2000。 |
PageNum | Integer | 否 | 1 | 當(dāng)前頁碼。默認值為1。 |
StreamType | String | 否 | all | 流類型。取值:
|
QueryType | String | 否 | fuzzy | 指定是否模糊匹配流名稱。取值:
|
返回數(shù)據(jù)
名稱 |
類型 |
示例值 |
描述 |
TotalPage | Integer | 2 | 總頁數(shù)。 |
PageNum | Integer | 1 | 分頁的頁碼。 |
PageSize | Integer | 10 | 每頁顯示的條數(shù)。 |
RequestId | String | 5c6a2a0df228-4a64- af62-20e91b9676b3 | 請求ID。 |
TotalNum | Integer | 11 | 符合條件的總個數(shù)。 |
OnlineInfo | Array of LiveStreamOnlineInfo | 正在推送流的信息。 |
|
LiveStreamOnlineInfo | |||
AudioDataRate | Integer | 600 | 直播流的音頻碼率。單位:Kbps。 |
FrameRate | Integer | 15 | 幀率。單位:FPS。 |
PublishUrl | String | rtmp://demo.aliyundoc.com/live/test**** | 推流完整URL地址。 |
StreamName | String | liveStream**** | 播流名稱。 |
AudioCodecId | Integer | 10 | 音頻Codec ID。 |
Height | Integer | 720 | 視頻分辨率高度。單位:pixel。 |
VideoDataRate | Integer | 600 | 直播流的視頻碼率。單位:Kbps。 |
DomainName | String | example.com | 主播流域名。 |
PublishDomain | String | demo.aliyundoc.com | 推流域名,使用中心推流的可直接填寫播流域名。 |
PublishTime | String | 2021-08-09T02:37:59Z | 開始推流時間。格式為:yyyy-MM-ddTHH:mm:ssZ(UTC時間)。 |
AppName | String | liveApp**** | 播流所屬應(yīng)用名稱。 |
PublishType | String | edge | 推流類型,取值:
|
VideoCodecId | Integer | 7 | 視頻Codec ID。 |
Transcoded | String | no | 是否是轉(zhuǎn)碼流。取值:
|
Width | Integer | 1280 | 視頻分辨率寬度。單位:pixel。 |
ClientIp | String | 106.11.XX.XX | 推流客戶端IP。 |
ServerIp | String | 120.221.XX.XX | 推流節(jié)點IP。 |
示例
請求示例
http(s)://live.aliyuncs.com/?Action=DescribeLiveStreamsOnlineList
&DomainName=example.com
&AppName=liveApp****
&StreamName=liveStream****
&OnlyStream=no
&PageSize=1500
&PageNum=1
&StreamType=all
&QueryType=fuzzy
&公共請求參數(shù)
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeLiveStreamsOnlineListResponse>
<TotalPage>2</TotalPage>
<PageNum>1</PageNum>
<PageSize>10</PageSize>
<RequestId>5c6a2a0df228-4a64- af62-20e91b9676b3</RequestId>
<TotalNum>11</TotalNum>
<OnlineInfo>
<AudioDataRate>600</AudioDataRate>
<FrameRate>15</FrameRate>
<PublishUrl>rtmp://demo.aliyundoc.com/live/test****</PublishUrl>
<StreamName>liveStream****</StreamName>
<AudioCodecId>10</AudioCodecId>
<Height>720</Height>
<VideoDataRate>600</VideoDataRate>
<DomainName>example.com</DomainName>
<PublishDomain>demo.aliyundoc.com</PublishDomain>
<PublishTime>2021-08-09T02:37:59Z</PublishTime>
<AppName>liveApp****</AppName>
<PublishType>edge</PublishType>
<VideoCodecId>7</VideoCodecId>
<Transcoded>no</Transcoded>
<Width>1280</Width>
<ClientIp>106.11.XX.XX</ClientIp>
<ServerIp>120.221.XX.XX</ServerIp>
</OnlineInfo>
</DescribeLiveStreamsOnlineListResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"TotalPage" : 2,
"PageNum" : 1,
"PageSize" : 10,
"RequestId" : "5c6a2a0df228-4a64- af62-20e91b9676b3",
"TotalNum" : 11,
"OnlineInfo" : {
"AudioDataRate" : 600,
"FrameRate" : 15,
"PublishUrl" : "rtmp://demo.aliyundoc.com/live/test****",
"StreamName" : "liveStream****",
"AudioCodecId" : 10,
"Height" : 720,
"VideoDataRate" : 600,
"DomainName" : "example.com",
"PublishDomain" : "demo.aliyundoc.com",
"PublishTime" : "2021-08-09T02:37:59Z",
"AppName" : "liveApp****",
"PublishType" : "edge",
"VideoCodecId" : 7,
"Transcoded" : "no",
"Width" : 1280,
"ClientIp" : "106.11.XX.XX",
"ServerIp" : "120.221.XX.XX"
}
}
錯誤碼
HttpCode |
錯誤碼 |
錯誤信息 |
描述 |
400 | InvalidStartTime.Malformed | Specified StartTime is malformed. | StartTime參數(shù)錯誤,請您確認該StartTime參數(shù)是否正確。 |
400 | InvalidEndTime.Malformed | Specified EndTime is malformed. | 結(jié)束時間錯誤,請您確認結(jié)束時間是否正確。 |
訪問錯誤中心查看更多錯誤碼。