DescribeVsStreamsPublishList - 获取VS流推流记录

更新时间:
复制为 MD 格式

获取某一时间段内某个域名(或域名下某应用或某个流)的推流记录。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

vs:DescribeVsStreamsPublishList

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

DomainName

string

您的域名。

example.aliyundoc.com

AppName

string

直播流所属应用名称。

xxxApp

StreamName

string

直播流名称。

xxxStream

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

PageSize

integer

每页大小。默认值:3000。
取值范围:[1,3000]

3000

PageNumber

integer

第几页。默认值:1。

1

StreamType

string

流类型。取值范围:

  • all(所有流)(默认)

  • raw(原始流)

  • trans(转码流)

all

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

每页大小。

3000

RequestId

string

请求 ID。

119F7639-4646-51A4-B6C1-300D391C0104

TotalNum

integer

符合条件的总个数。

200

PublishInfo

object

LiveStreamPublishInfo

array<object>

推流记录信息。

object

EdgeNodeAddr

string

CDN 上行节点 IP。

192.168.0.1

PublishUrl

string

推流完整 URL 地址。

https://example.aliyundoc.com/xxxApp/3402000****320000001.m3u8

StreamName

string

直播流名称。

xxxStream

DomainName

string

流所属加速域名。

example.aliyundoc.com

StopTime

string

停止推流时刻。 格式为 UTC 时间。

2016-06-29T19:00:00Z

TranscodeId

string

转码模板 ID。

说明

若转码过,会返回转码模板 ID。

3888920****8138204-cn-qingdao

PublishDomain

string

推流域名。

example.aliyundoc.com

AppName

string

流所属应用名称。

xxxApp

PublishTime

string

开始推流时刻。格式为 UTC 时间。

2016-06-29T19:00:00Z

PublishType

string

推流类型。取值范围:

  • edge(边缘推流)

  • center(中心推流)

center

Transcoded

string

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

  • yes(是)

  • no(否)

yes

ClientAddr

string

主播 IP。

192.168.0.1

StreamUrl

string

直播流的 URL。

https://example.aliyundoc.com/xxxApp/3402000****320000001.m3u8

示例

正常返回示例

JSON格式

{
  "TotalPage": 1,
  "PageNum": 1,
  "PageSize": 3000,
  "RequestId": "119F7639-4646-51A4-B6C1-300D391C0104",
  "TotalNum": 200,
  "PublishInfo": {
    "LiveStreamPublishInfo": [
      {
        "EdgeNodeAddr": "192.168.0.1",
        "PublishUrl": "https://example.aliyundoc.com/xxxApp/3402000****320000001.m3u8",
        "StreamName": "xxxStream",
        "DomainName": "example.aliyundoc.com",
        "StopTime": "2016-06-29T19:00:00Z",
        "TranscodeId": "3888920****8138204-cn-qingdao",
        "PublishDomain": "example.aliyundoc.com",
        "AppName": "xxxApp",
        "PublishTime": "2016-06-29T19:00:00Z",
        "PublishType": "center",
        "Transcoded": "yes",
        "ClientAddr": "192.168.0.1",
        "StreamUrl": "https://example.aliyundoc.com/xxxApp/3402000****320000001.m3u8"
      }
    ]
  }
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidEndTime.Mismatch The specified EndTime is earlier than the StartTime. 结束时间早于开始时间,请检查

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

变更历史

更多信息,参考变更详情