更新时间:2026-03-26 GMT+08:00
分享

更新转推输出 - ModifyFlowOutput

功能介绍

更新转推输出

调试

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

授权信息

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

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

live:ott:updateFlowOutput

Write

-

-

-

-

URI

PUT /v1/{project_id}/flows/outputs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

不涉及

取值范围

[1,32]

默认取值

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

flow_id

String

参数解释

流id

约束限制

不涉及

取值范围

长度为[1~64]个字符。

默认取值

不涉及

output_name

String

参数解释

输出名称

约束限制

不涉及

取值范围

长度为[1~64]个字符。

默认取值

不涉及

请求参数

表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]

默认取值

不涉及

表4 请求Body参数

参数

是否必选

参数类型

描述

cidr_whitelist

Array of strings

参数解释

IP白名单列表

约束限制

不涉及

取值范围

限制[0~20]条

默认取值

不涉及

destination

String

参数解释

推流地址,支持ip和域名

约束限制

不涉及

取值范围

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

默认取值

不涉及

encryption

FlowSourceDecryption object

参数解释

StreamConnect flow解密信息

约束限制

不涉及

output_status

String

参数解释

输出状态

约束限制

不涉及

取值范围

  • ENABLED:启用

  • DISABLED:禁用

默认取值:

ENABLED

port

Integer

参数解释

端口

约束限制

不涉及

默认取值

不涉及

取值范围:

1024~65535

stream_id

String

参数解释

srt-caller模式支持设置streamid

约束限制

不涉及

取值范围

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

默认取值

不涉及d

description

String

参数解释

输出描述

约束限制

不涉及

取值范围

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

默认取值

不涉及

min_latency

Integer

参数解释

最小时延,单位毫秒

约束限制

不涉及

取值范围:

10~15000

默认取值:

2000

表5 FlowSourceDecryption

参数

是否必选

参数类型

描述

algorithm

String

参数解释

加密算法

约束限制

不涉及

取值范围

  • aes128: 加密算法为aes-128

  • aes192: 加密算法为aes-192

  • aes256: 加密算法为AES-256

默认取值:

aes256

key_type

String

参数解释

密钥类型

约束限制

目前仅支持srt-password类型,其他类型暂不支持

取值范围

  • speke: 使用speke协议获取密钥

  • static-key: 静态密钥

  • srt-password: SRT协议密钥

默认取值

aes256

passphrase

String

参数解释

srt解密密钥,用于flow对srt流进行解密

约束限制

不涉及

取值范围

限制[10~79]个字符长度

默认取值

不涉及

响应参数

状态码:200

表6 响应Body参数

参数

参数类型

描述

cidr_whitelist

Array of strings

参数解释

IP白名单列表

取值范围

限制[0~20]条

destination

String

参数解释

推流地址,支持ip和域名

取值范围

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

name

String

参数解释

output名称

取值范围

大小写字母,数字,中划线,下划线;只能以字母开头,且限制[1~64]个字符长度

encryption

FlowSourceDecryption object

参数解释

StreamConnect flow解密信息

约束限制

不涉及

output_status

String

参数解释

输出状态

取值范围

  • ENABLED:启用

  • DISABLED:禁用

默认取值:

ENABLED

listener_address

String

参数解释

srt-listener模式,监听地址,不支持修改

取值范围

长度为[7~15]个字符

port

Integer

参数解释

端口,如果srt-listener为监听端口,那么srt-caller为对端端口

取值范围:

1024~65535

protocol

String

参数解释

协议

取值范围

  • srt-listener

  • srt-caller

stream_id

String

参数解释

srt-caller模式支持设置streamid

取值范围

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

description

String

参数解释

输出描述

取值范围

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

min_latency

Integer

参数解释

最小时延,单位毫秒

取值范围:

10~15000

默认取值:

2000

health_status

String

参数解释

转推流状态

取值范围

  • CONNECTED:转推中

  • DISCONNECTED:转推中断

默认取值:

DISCONNECTED

type

String

参数解释

输出类型

取值范围

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

表7 FlowSourceDecryption

参数

参数类型

描述

algorithm

String

参数解释

加密算法

约束限制

不涉及

取值范围

  • aes128: 加密算法为aes-128

  • aes192: 加密算法为aes-192

  • aes256: 加密算法为AES-256

默认取值:

aes256

key_type

String

参数解释

密钥类型

约束限制

目前仅支持srt-password类型,其他类型暂不支持

取值范围

  • speke: 使用speke协议获取密钥

  • static-key: 静态密钥

  • srt-password: SRT协议密钥

默认取值

aes256

passphrase

String

参数解释

srt解密密钥,用于flow对srt流进行解密

约束限制

不涉及

取值范围

限制[10~79]个字符长度

默认取值

不涉及

状态码:400

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码

取值范围

详见错误码

error_msg

String

参数解释

错误描述

取值范围

详见错误码描述

请求示例

https://{endpoint}/v1/{project_id}/flows/outputs?flow_id={flow_id}&output_name={output_name}

{
  "destination" : "10.10.10.10",
  "min_latency" : 1000,
  "port" : 2001,
  "cidr_whitelist" : [ "0.0.0.0/0" ],
  "encryption" : {
    "algorithm" : "aes256",
    "key_type" : "srt-password",
    "passphrase" : "******"
  },
  "output_status" : "ENABLED",
  "description" : "ccccc"
}

响应示例

状态码:200

flow转推输出

{
  "name" : "test",
  "protocol" : "srt-caller",
  "destination" : "10.10.10.10",
  "min_latency" : 1000,
  "port" : 2001,
  "cidr_whitelist" : [ "0.0.0.0/0" ],
  "encryption" : {
    "algorithm" : "aes256",
    "key_type" : "srt-password",
    "passphrase" : "******"
  },
  "health_status" : "DISCONNECTED",
  "output_status" : "ENABLED",
  "description" : "ccccc"
}

状态码:400

流输出修改失败响应

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "output_name test not exist in flow"
}

状态码

状态码

描述

200

flow转推输出

400

流输出修改失败响应

错误码

请参见错误码

相关文档