文档首页/视频直播 Live/媒体直播API参考/流连接管理/获取流列表 - ListFlows
更新时间：2026-03-26 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取流列表 - ListFlows

功能介绍

获取流列表

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

live:ott:listFlow

List

-

-

-

-

URI

GET /v1/{project_id}/flows

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID，获取方法请参考获取项目ID。

约束限制：

不涉及

取值范围：

[1,32]

默认取值：

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

参数解释：

每页记录数

约束限制：

不涉及

取值范围：

1~100

默认取值：

10

offset

否

Integer

参数解释：

偏移量。表示从此偏移量开始查询，offset大于等于0

约束限制：

不涉及

取值范围：

0~6553500

默认取值：

0

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

参数解释：

用户Token，使用Token鉴权方式时为必填项。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

约束限制：

不涉及

取值范围：

[1,256]

默认取值：

不涉及

Authorization

否

String

参数解释：

使用AK/SK方式认证时必填，携带的鉴权信息。

约束限制：

不涉及

取值范围：

[1,256]

默认取值：

不涉及

X-Sdk-Date

否

String

参数解释：

请求的发生时间，使用AK/SK方式认证时为必填项。

约束限制：

不涉及

取值范围：

[1,256]

默认取值：

不涉及

X-Project-Id

否

String

参数解释：

使用AK/SK方式认证时为必填项，携带项目ID信息。

约束限制：

不涉及

取值范围：

[1,64]

默认取值：

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

total

Integer

参数解释：

总数

取值范围：

0~1000

flows

Array of ListFlowRespItem objects

参数解释：

流列表

表5 ListFlowRespItem

参数

参数类型

描述

name

String

参数解释：

流名称

取值范围：

限制[1~64]个字符长度

region

String

参数解释：

区域

取值范围：

限制[1~64]个字符长度

flow_id

String

参数解释：

流id

取值范围：

限制[1~64]个字符长度

status

String

参数解释：

当前状态，ACTIVE运行中，STANDBY未启动

取值范围：

  • ACTIVE

  • STANDBY

description

String

参数解释：

描述

取值范围：

限制[1~255]个字符长度

protocol

String

参数解释：

协议，srt-caller，srt-listener

取值范围：

  • srt-caller

  • srt-listener

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码

取值范围：

详见错误码。

error_msg

String

参数解释：

错误描述

取值范围：

详见错误码描述。

请求示例

无

响应示例

状态码：200

查询流列表响应

{
  "total" : 8,
  "flows" : [ {
    "name" : "test",
    "region" : "cn-north-5",
    "flow_id" : "fcbc63d1-06d8-47ba-8fd9-cd0096b72f6d",
    "status" : "STANDBY",
    "description" : "test",
    "protocol" : "srt-caller"
  } ]
}

状态码：400

错误响应

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Request parameters is invalid"
}

状态码

状态码

描述

200

查询流列表响应

400

错误响应

错误码

请参见错误码。

父主题：流连接管理

相关文档