视频接入服务 VIS-获取视频流列表:URI

时间:2025-01-26 10:35:34

URI

GET /v1/{project_id}/streams

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参考获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

查询的开始位置,取值范围为0~100000,必须与limit一起使用。与limit同时缺省时,返回所有结果。该参数适用于所有查询列表的接口。如果offset超过数据总条数,则结果返回空列表。

limit

Integer

返回结果的最大条目数,取值范围为1~1000,必须与offset一起使用。与offset同时缺省时,返回所有结果。该参数适用于所有查询列表的接口。

sort

String

返回结果的排序规则。

  • ASC:表示升序。

  • DESC:表示降序。

默认为ASC,需要有offset和limit参数,sort参数才会生效。

order_by

String

选择按一个字段排序,可选值如下。

  • encode_type:视频流编码格式。

  • access_type: 视频接入 类型。

  • share_type:视频流共享类型。

  • created_at:视频流创建时间。

  • name:视频流名字。

  • state:视频流状态。

  • retention_state:视频流转储状态。

默认为created_at,按照创建时间排序。需要有offset和limit参数,order_by参数才会生效。

name

String

按照视频流名称过滤,支持模糊查询。

stream_state

String

按视频流状态过滤,可选值如下。

  • ACTIVE:表示已激活。

  • STOPPED:表示未激活。

不区分大小写。

retention_state

String

按视频流转储状态过滤,可选值如下。

  • ACTIVE:表示已启用转储。

  • STOPPED:表示未启用转储。

不区分大小写。

support.huaweicloud.com/api-vis/ListStreams.html