DescribeVsStreamsOnlineList - 查询所有正在推的流的信息

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

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vs:DescribeVsStreamsOnlineListget
  • 全部资源
    *

请求参数

名称类型必填描述示例值
DomainNamestring

您的加速域名。

example.com
AppNamestring

应用名称。

xxxApp
StreamNamestring

流名称。

xxxStream
PageSizeinteger

每页大小。默认值:3000。

取值范围:[1,3000]

10
PageNuminteger

第几个分页,默认值:1。

1
StreamTypestring

流类型。取值范围:

  • all(所有流)(默认)
  • raw(原始流)
  • trans(转码流)
all
StartTimestring

起始时间。

说明 为 UTC 格式,例如:2016-06-29T19:00:00Z
2016-06-29T19:00:00Z
EndTimestring

结束时间。

说明
  • 为 UTC 格式,例如:2016-06-30T19:00:00Z
  • EndTime 和 StartTime 之间的间隔不能超过 30 天。
  • 2016-06-30T19:00:00Z
    QueryTypestring

    指定是否模糊匹配流名称。取值范围:

    • fuzzy(模糊匹配)
    • strict(精准匹配)
    fuzzy
    OrderBystring

    排序方式。取值范围:

    • stream_name_desc(按直播流名称倒序)
    • stream_name_asc(按直播流名称升序)
    • publish_time_desc(按推流时间倒序)
    • publish_time_asc(按推流时间升序)(默认值)
    publish_time_asc

    返回参数

    名称类型描述示例值
    object
    TotalPageinteger

    总页数。

    1
    PageNuminteger

    分页的页码。

    1
    PageSizeinteger

    每页显示的条数。

    10
    RequestIdstring

    请求 ID。

    B31FC4AD-3592-573E-8063-878F722B322A
    TotalNuminteger

    符合条件的总个数。

    10
    OnlineInfoarray<object>

    正在推送流的信息。

    LiveStreamOnlineInfoobject
    PublishTimestring

    开始推流时刻,UTC 时间。

    2015-12-02T06:58:04Z
    AppNamestring

    流所属应用名称。

    xxxApp
    PublishTypestring

    推流类型。取值范围:

    • edge(边缘推流)
    • center(中心推流)
    edge
    PublishUrlstring

    推流完整 URL 地址。

    rtmp://example.com/xchen
    Transcodedstring

    是否为转码流。取值范围:

    • yes(是)
    • no(否)
    no
    StreamNamestring

    流名称。

    testxchen_small
    DomainNamestring

    流所属加速域名。

    example.com
    TranscodeIdstring

    转码模板 ID。

    说明
  • 若转码过,会返回转码模板 ID。
  • 对于原始流,返回当前 AppName 下配置的转码模板 ID 列表,用英文逗号(,)分隔。
  • 123
    PublishDomainstring

    推流域名。

    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错误码错误信息描述
    400InvalidEndTime.MismatchThe specified EndTime is earlier than the StartTime.结束时间早于开始时间,请检查

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

    特殊错误码

    错误代码描述HTTP 状态码语义
    InternalErrorThe request processing has failed due to some unknown error.500后台发生未知错误。
    InvalidDomain.NotFoundThe domain provided does not exist in our records.404当前账户下未查到域名。
    IllegalOperationIllegal domain operate is not permitted.403不支持当前操作,如:非直播类域名。