修改流来源 - ModifyFlowSources
功能介绍
修改流来源
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。
|
授权项 |
访问级别 |
资源类型（*为必须） |
条件键 |
别名 |
依赖的授权项 |
|---|---|---|---|---|---|
|
live:ott:updateFlowSource |
Write |
- |
- |
- |
- |
URI
PUT /v1/{project_id}/flows/sources
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，获取方法请参考获取项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
flow_id |
是 |
String |
参数解释: 流id 约束限制: 不涉及 取值范围: 长度为[1~64]个字符。 默认取值: 不涉及 |
|
source_name |
是 |
String |
参数解释: 流源名称 约束限制: 不涉及 取值范围: 长度为[1~64]个字符。 默认取值: 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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信息。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
source |
是 |
FlowSource object |
源流信息 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
source_listener_address |
否 |
String |
拉流地址 |
|
source_listener_port |
否 |
Integer |
拉流端口，2077/2088不可选 |
|
stream_id |
否 |
String |
srt拉流streamid |
|
min_latency |
否 |
Integer |
最小时延，单位ms |
|
cidr_whitelist |
否 |
Array of strings |
推流CIDR IP白名单列表 |
|
description |
否 |
String |
描述 |
|
protocol |
是 |
String |
协议，srt-caller，srt-listener |
|
name |
是 |
String |
入流资源名称 |
|
decryption |
否 |
FlowSourceDecryption object |
StreamConnect flow解密信息, |
|
health_status |
否 |
String |
转推流状态，CONNECTED：转推中，DISCONNECTED：转推中断 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
flow_id |
String |
流id |
|
source |
FlowSource object |
源流信息 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
source_listener_address |
String |
拉流地址 |
|
source_listener_port |
Integer |
拉流端口，2077/2088不可选 |
|
stream_id |
String |
srt拉流streamid |
|
min_latency |
Integer |
最小时延，单位ms |
|
cidr_whitelist |
Array of strings |
推流CIDR IP白名单列表 |
|
description |
String |
描述 |
|
protocol |
String |
协议，srt-caller，srt-listener |
|
name |
String |
入流资源名称 |
|
decryption |
FlowSourceDecryption object |
StreamConnect flow解密信息, |
|
health_status |
String |
转推流状态，CONNECTED：转推中，DISCONNECTED：转推中断 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
algorithm |
String |
加密算法，aes128: 加密算法为aes-128，aes192:加密算法为aes-192，aes256: 加密算法为AES-256 |
|
key_type |
String |
秘钥类型,speke:使用speke协议获取秘钥,static-key:静态秘钥,srt-password:SRT协议秘钥 目前仅支持srt-password类型，其他类型暂不支持 |
|
passphrase |
String |
srt解密秘钥，用于flow对srt流进行解密 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
https://{endpoint}/v1/{project_id}/flows/sources?flow_id={flow_id}&source_name={source_name}
{
"source" : {
"description" : "test_caller",
"min_latency" : 2000,
"source_listener_port" : 5000,
"source_listener_address" : "srt://100.10.10.10",
"cidr_whitelist" : [ "0.0.0.0/32" ],
"protocol" : "srt-caller",
"name" : "test_caller",
"decryption" : {
"algorithm" : "aes256",
"key_type" : "srt-password",
"passphrase" : "******"
}
}
}
响应示例
状态码：200
修改状态状态成功响应
{
"flow_id" : "ec897482-d24b-4d64-aa39-407980902b1d",
"source" : {
"description" : "test",
"source_listener_port" : 5000,
"source_listener_address" : "10.10.10.10",
"protocol" : "srt-caller",
"name" : "test",
"decryption" : {
"algorithm" : "aes256",
"key_type" : "srt-password",
"passphrase" : "******"
}
}
}
状态码：400
失败响应
{
"error_code" : "LIVE.103011019",
"error_msg" : "flow_id not exist"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
修改状态状态成功响应 |
|
400 |
失败响应 |
错误码
请参见错误码。
