创建流 - CreateFlows
功能介绍
创建流
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
live:ott:createFlow | Write | - | - | - | - |
URI
POST /v1/{project_id}/flows
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 参数解释: 项目ID,获取方法请参考获取项目ID。 约束限制: 不涉及 取值范围: [1,32] 默认取值: 不涉及 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
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] 默认取值: 不涉及 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
name | 是 | String | 参数解释: 流名称 约束限制: 不涉及 取值范围: 限制[1~64]个字符长度 默认取值: 不涉及 |
region | 是 | String | 参数解释: 区域 约束限制: 不涉及 取值范围: 限制[1~64]个字符长度 默认取值: 不涉及 |
sources | 是 | Array of FlowSource objects | 参数解释: 入流信息 约束限制: 不涉及 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
source_listener_address | 否 | String | 参数解释: 拉流地址 约束限制: 不涉及 取值范围: 长度为[0~255]个字符 默认取值: 不涉及 |
source_listener_port | 否 | Integer | 参数解释: 拉流端口 约束限制: 2077/2088不可选 默认取值: 不涉及 取值范围: 1024~65535 |
stream_id | 否 | String | 参数解释: srt拉流streamid 约束限制: 不涉及 取值范围: 长度为[1~512]个字符 默认取值: 不涉及 |
min_latency | 否 | Integer | 参数解释: 最小时延,单位ms 约束限制: 不涉及 默认取值: 不涉及 取值范围: 10~15000 |
cidr_whitelist | 否 | Array of strings | 参数解释: 推流CIDR IP白名单列表 约束限制: 不涉及 取值范围: 限制[0~20]条 默认取值: 不涉及 |
description | 否 | String | 参数解释: 描述 约束限制: 不涉及 取值范围: 长度为[0~255]个字符 默认取值: 不涉及 |
protocol | 是 | String | 参数解释: 协议 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
name | 是 | String | 参数解释: 入流资源名称 约束限制: 不涉及 取值范围: 长度为[1~64]个字符,且满足正则^([a-zA-Z0-9-_]){1,64}$ 默认取值: 不涉及 |
decryption | 否 | FlowSourceDecryption object | 参数解释: StreamConnect flow解密信息 约束限制: 不涉及 |
health_status | 否 | String | 参数解释: 转推流状态 约束限制: 不涉及 取值范围: 默认取值: DISCONNECTED |
响应参数
状态码:201
参数 | 参数类型 | 描述 |
|---|---|---|
flow | FlowDetailRespBody object | 参数解释 流信息 |
参数 | 参数类型 | 描述 |
|---|---|---|
name | String | 参数解释: 流名称 取值范围: 限制[1~64]个字符长度 |
region | String | 参数解释: 区域 取值范围: 限制[1~64]个字符长度 |
sources | Array of FlowSource objects | 参数解释: 入流信息,当前限制最多有一个入流。 |
status | String | 参数解释: 状态 取值范围: |
flow_id | String | 参数解释: 流id 取值范围: 限制[1~64]个字符长度 |
outputs | Array of FlowOutput objects | 参数解释: 流输出信息,取值范围[0~12]。 |
参数 | 参数类型 | 描述 |
|---|---|---|
source_listener_address | String | 参数解释: 拉流地址 约束限制: 不涉及 取值范围: 长度为[0~255]个字符 默认取值: 不涉及 |
source_listener_port | Integer | 参数解释: 拉流端口 约束限制: 2077/2088不可选 默认取值: 不涉及 取值范围: 1024~65535 |
stream_id | String | 参数解释: srt拉流streamid 约束限制: 不涉及 取值范围: 长度为[1~512]个字符 默认取值: 不涉及 |
min_latency | Integer | 参数解释: 最小时延,单位ms 约束限制: 不涉及 默认取值: 不涉及 取值范围: 10~15000 |
cidr_whitelist | Array of strings | 参数解释: 推流CIDR IP白名单列表 约束限制: 不涉及 取值范围: 限制[0~20]条 默认取值: 不涉及 |
description | String | 参数解释: 描述 约束限制: 不涉及 取值范围: 长度为[0~255]个字符 默认取值: 不涉及 |
protocol | String | 参数解释: 协议 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
name | String | 参数解释: 入流资源名称 约束限制: 不涉及 取值范围: 长度为[1~64]个字符,且满足正则^([a-zA-Z0-9-_]){1,64}$ 默认取值: 不涉及 |
decryption | FlowSourceDecryption object | 参数解释: StreamConnect flow解密信息 约束限制: 不涉及 |
health_status | String | 参数解释: 转推流状态 约束限制: 不涉及 取值范围: 默认取值: DISCONNECTED |
参数 | 参数类型 | 描述 |
|---|---|---|
algorithm | String | 参数解释: 加密算法 约束限制: 不涉及 取值范围: 默认取值: aes256 |
key_type | String | 参数解释: 密钥类型 约束限制: 目前仅支持srt-password类型,其他类型暂不支持 取值范围: 默认取值: aes256 |
passphrase | String | 参数解释: srt解密密钥,用于flow对srt流进行解密 约束限制: 不涉及 取值范围: 限制[10~79]个字符长度 默认取值: 不涉及 |
状态码:400
请求示例
https://{endpoint}/v1/{project_id}/flows
{
"name" : "test_caller",
"region" : "cn-north-5",
"sources" : [ {
"source_listener_address" : "srt://100.10.10.10",
"source_listener_port" : 5000,
"stream_id" : "",
"min_latency" : 2000,
"cidr_whitelist" : [ "0.0.0.0/32" ],
"description" : "test_caller",
"protocol" : "srt-caller",
"name" : "gzztest_caller",
"decryption" : {
"algorithm" : "aes256",
"key_type" : "srt-password",
"passphrase" : "*******"
}
} ]
} 响应示例
状态码:201
流创建成功响应
{
"flow" : {
"name" : "test_caller",
"region" : "cn-north-5",
"sources" : [ {
"description" : "test_caller",
"min_latency" : 2000,
"source_listener_port" : 5000,
"source_listener_address" : "srt://100.11.10.10",
"cidr_whitelist" : [ "0.0.0.0/32", "192.168.0.1/16" ],
"protocol" : "srt-caller",
"name" : "test_caller",
"decryption" : {
"algorithm" : "aes256",
"key_type" : "srt-password",
"passphrase" : "******"
}
} ],
"flow_id" : "fcbc63d1-06d8-47ba-8fd9-cd0096b72f6d",
"status" : "STANDBY"
}
} 状态码:400
流创建失败响应
{
"error_code" : "LIVE.103011018",
"error_msg" : "The resource to create is already exists"
} 状态码
状态码 | 描述 |
|---|---|
201 | 流创建成功响应 |
400 | 流创建失败响应 |
错误码
请参见错误码。

