查看指定域名下(或者指定域名下某個應用)的所有正在推的流的信息。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
vs:DescribeVsStreamsOnlineList | get |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DomainName | string | 是 | 您的加速域名。 | example.com |
AppName | string | 否 | 應用名稱。 | xxxApp |
StreamName | string | 否 | 流名稱。 | xxxStream |
PageSize | integer | 否 | 每頁大小。默認值:3000。 取值范圍:[1,3000] | 10 |
PageNum | integer | 否 | 第幾個分頁,默認值:1。 | 1 |
StreamType | string | 否 | 流類型。取值范圍:
| all |
StartTime | string | 否 | 起始時間。 說明
為 UTC 格式,例如:2016-06-29T19:00:00Z
| 2016-06-29T19:00:00Z |
EndTime | string | 否 | 結束時間。 說明
| 2016-06-30T19:00:00Z |
QueryType | string | 否 | 指定是否模糊匹配流名稱。取值范圍:
| fuzzy |
OrderBy | string | 否 | 排序方式。取值范圍:
| publish_time_asc |
返回參數
示例
正常返回示例
JSON
格式
{
"TotalPage": 1,
"PageNum": 1,
"PageSize": 10,
"RequestId": "B31FC4AD-3592-573E-8063-878F722B322A",
"TotalNum": 10,
"OnlineInfo": {
"LiveStreamOnlineInfo": [
{
"PublishTime": "2015-12-02T06:58:04Z",
"AppName": "xxxApp",
"PublishType": "edge",
"PublishUrl": "rtmp://example.com/xchen",
"Transcoded": "no",
"StreamName": "testxchen_small",
"DomainName": "example.com",
"TranscodeId": "123",
"PublishDomain": "push.example.com"
}
]
}
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | InvalidEndTime.Mismatch | The specified EndTime is earlier than the StartTime. | 結束時間早于開始時間,請檢查 |
訪問錯誤中心查看更多錯誤碼。