查看指定域名下(或者指定域名下某个应用)的所有正在推的流的信息。
调试
您可以在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. | 结束时间早于开始时间,请检查 |
访问错误中心查看更多错误码。