调用DescribeVsStreamsOnlineList获取在线推流列表-视图计算-阿里云

查看指定域名下（或者指定域名下某个应用）的所有正在推的流的信息。

调试

您可以在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（所有流）（默认） raw（原始流） trans（转码流）	all
StartTime	string	否	起始时间。说明为 UTC 格式，例如：2016-06-29T19:00:00Z	2016-06-29T19:00:00Z
EndTime	string	否	结束时间。说明为 UTC 格式，例如：2016-06-30T19:00:00Z EndTime 和 StartTime 之间的间隔不能超过 30 天。	2016-06-30T19:00:00Z
QueryType	string	否	指定是否模糊匹配流名称。取值范围： fuzzy（模糊匹配） strict（精准匹配）	fuzzy
OrderBy	string	否	排序方式。取值范围： stream_name_desc（按直播流名称倒序） stream_name_asc（按直播流名称升序） publish_time_desc（按推流时间倒序） publish_time_asc（按推流时间升序）（默认值）	publish_time_asc

返回参数

名称	类型	描述	示例值
	object
TotalPage	integer	总页数。	1
PageNum	integer	分页的页码。	1
PageSize	integer	每页显示的条数。	10
RequestId	string	请求 ID。	B31FC4AD-3592-573E-8063-878F722B322A
TotalNum	integer	符合条件的总个数。	10
OnlineInfo	object
LiveStreamOnlineInfo	array<object>	正在推送流的信息。
	object
PublishTime	string	开始推流时刻，UTC 时间。	2015-12-02T06:58:04Z
AppName	string	流所属应用名称。	xxxApp
PublishType	string	推流类型。取值范围： edge（边缘推流） center（中心推流）	edge
PublishUrl	string	推流完整 URL 地址。	rtmp://example.com/xchen
Transcoded	string	是否为转码流。取值范围： yes（是） no（否）	no
StreamName	string	流名称。	testxchen_small
DomainName	string	流所属加速域名。	example.com
TranscodeId	string	转码模板 ID。说明若转码过，会返回转码模板 ID。对于原始流，返回当前 AppName 下配置的转码模板 ID 列表，用英文逗号（,）分隔。	123
PublishDomain	string	推流域名。	push.example.com

示例

正常返回示例

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.	结束时间早于开始时间，请检查

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。