获取流列表
功能介绍
获取流列表
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/flows
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，获取方法请参考获取项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
limit |
否 |
Integer |
每页记录数 取值范围[1,100] 默认值：10 |
|
offset |
否 |
Integer |
偏移量。表示从此偏移量开始查询，offset大于等于0 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
用户Token，使用Token鉴权方式时为必填项。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
|
Authorization |
否 |
String |
使用AK/SK方式认证时必填，携带的鉴权信息。 |
|
X-Sdk-Date |
否 |
String |
请求的发生时间，使用AK/SK方式认证时为必填项。 |
|
X-Project-Id |
否 |
String |
使用AK/SK方式认证时为必填项，携带项目ID信息。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
总数 |
|
flows |
Array of ListFlowRespItem objects |
流列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
流名称 |
|
region |
String |
区域 |
|
flow_id |
String |
流id |
|
status |
String |
当前状态，ACTIVE运行中，STANDBY未启动 |
|
description |
String |
描述 |
|
protocol |
String |
协议，srt-caller，srt-listener |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
无
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询流列表响应 |
|
400 |
错误响应 |
错误码
请参见错误码。
