Modifying a Flow Source
Function
Modifies a flow source.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.
|
Action |
Access Level |
Resource Type (*: required) |
Condition Key |
Alias |
Dependencies |
|---|---|---|---|---|---|
|
live:ott:updateFlowSource |
Write |
- |
- |
- |
- |
URI
PUT /v1/{project_id}/flows/sources
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see "Obtaining a Project ID". |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
flow_id |
Yes |
String |
Flow ID |
|
source_name |
Yes |
String |
Flow source name |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
No |
String |
User token. This parameter is mandatory when token authentication is used. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
|
Authorization |
No |
String |
Authentication information. This parameter is mandatory for AK/SK authentication. |
|
X-Sdk-Date |
No |
String |
Request time. This parameter is mandatory for AK/SK authentication. |
|
X-Project-Id |
No |
String |
Project ID. This parameter is mandatory for AK/SK authentication. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
source |
Yes |
FlowSource object |
Source stream information |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
source_listener_address |
No |
String |
Ingest URL |
|
source_listener_port |
No |
Integer |
Port that pulls streams. 2077 and 2088 are not allowed. |
|
stream_id |
No |
String |
streamid of SRT stream pull |
|
min_latency |
No |
Integer |
Minimum latency, in millisecond. |
|
cidr_whitelist |
No |
Array of strings |
CIDR IP whitelist for stream push |
|
description |
No |
String |
Description |
|
protocol |
Yes |
String |
Protocol. The value can be srt-caller or srt-listener. |
|
name |
Yes |
String |
Input resource name |
|
decryption |
No |
FlowSourceDecryption object |
Flow decryption information in StreamConnect. |
|
health_status |
No |
String |
Indicates the stream push status. The options are as follows: CONNECTED: The stream is being pushed; DISCONNECTED: The stream push is interrupted. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
algorithm |
No |
String |
Encryption algorithm. The value can be aes128 (AES-128), aes192 (AES-192), or aes256 (AES-256). |
|
key_type |
Yes |
String |
Key type. The value can be speke (obtaining keys using the SPEKE protocol), static-key (static key), or srt-password (SRT key). Currently, only srt-password is supported. |
|
passphrase |
Yes |
String |
SRT decryption key, which is used by a flow to decrypt SRT streams. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
flow_id |
String |
Flow ID |
|
source |
FlowSource object |
Source stream information |
|
Parameter |
Type |
Description |
|---|---|---|
|
source_listener_address |
String |
Ingest URL |
|
source_listener_port |
Integer |
Port that pulls streams. 2077 and 2088 are not allowed. |
|
stream_id |
String |
streamid of SRT stream pull |
|
min_latency |
Integer |
Minimum latency, in millisecond. |
|
cidr_whitelist |
Array of strings |
CIDR IP whitelist for stream push |
|
description |
String |
Description |
|
protocol |
String |
Protocol. The value can be srt-caller or srt-listener. |
|
name |
String |
Input resource name |
|
decryption |
FlowSourceDecryption object |
Flow decryption information in StreamConnect. |
|
health_status |
String |
Indicates the stream push status. The options are as follows: CONNECTED: The stream is being pushed; DISCONNECTED: The stream push is interrupted. |
|
Parameter |
Type |
Description |
|---|---|---|
|
algorithm |
String |
Encryption algorithm. The value can be aes128 (AES-128), aes192 (AES-192), or aes256 (AES-256). |
|
key_type |
String |
Key type. The value can be speke (obtaining keys using the SPEKE protocol), static-key (static key), or srt-password (SRT key). Currently, only srt-password is supported. |
|
passphrase |
String |
SRT decryption key, which is used by a flow to decrypt SRT streams. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code |
|
error_msg |
String |
Error message |
Example Requests
None
Example Responses
None
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Response indicating a successful status change |
|
400 |
Response indicating a failure |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot