ModifyDataFlow

Last updated:2026-03-11 22:55:02

ModifyDataFlow

Last updated: 2026-03-11 22:55:02

1. API Description

Domain name for API request: cfs.intl.tencentcloudapi.com.

Modify data flow parameters.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: ModifyDataFlow.
Version	Yes	String	Common Params. The value used for this API: 2019-07-19.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
DataFlowId	Yes	String	Data flow manage ID, obtained through the api for querying data flow.
FileSystemId	Yes	String	File system ID, which can be obtained by querying the file system through the DescribeCfsFileSystems api.
DataFlowName	No	String	Data flow name, supports no more than 64 characters in length, supports chinese, numbers, _, and -.
SecretId	No	String	Key ID.
SecretKey	No	String	key.
UserKafkaTopic	No	String	Topic Parameter used by KafkaConsumer during consumption
ServerAddr	No	String	Service address.
UserName	No	String	name
Password	No	String	Kafka consuming user password.
AutoRefresh	No	Integer	Metadata incremental update switch; 1 enables, 0 disables.

3. Output Parameters

Parameter Name	Type	Description
DataFlowId	String	Data flow manage ID.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Rectifying Data Flow Parameters

Input Example

POST / HTTP/1.1
Host: cfs.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDataFlow
<Common request parameters>

{
    "DataFlowId": "cfs-dataflow-9e911f3c",
    "FileSystemId": "cfs-44d53b63e",
    "DataFlowName": "testest"
}

Output Example

{
    "Response": {
        "DataFlowId": "cfs-dataflow-9e911f3c",
        "RequestId": "948ff9b3-5950-4dff-841d-78796f21396c"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
InvalidParameterValue.InvalidDataFlowId	Parameter value error: data flow ID invalid.
InvalidParameterValue.InvalidDataFlowName	Invalid data flow name.
InvalidParameterValue.InvalidDataFlowSourceInfo	Parameter value error: invalid data flow source information. check the key and path.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud