UpdateWorkflowInfo

Last updated: 2025-11-13 20:56:37

UpdateWorkflowInfo

Last updated: 2025-11-13 20:56:37

1. API Description

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

This API is developed in ds.
This API is used to update a workflow, including its basic information and workflow 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: UpdateWorkflowInfo.
Version	Yes	String	Common Params. The value used for this API: 2021-08-20.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-singapore, eu-frankfurt, na-ashburn, na-siliconvalley.
ProjectId	Yes	String	Project ID
OperatorName	Yes	String	Operator Name
WorkflowId	Yes	String	Workflow ID
Owner	No	String	Responsible Person
OwnerId	No	String	Responsible Person ID
WorkflowDesc	No	String	Remarks
WorkflowName	No	String	Workflow Name
FolderId	No	String	Folder ID
UserGroupId	No	String	Workflow user group id. if there are multiple, separate them with a semicolon: a;b;c
UserGroupName	No	String	Workflow user group name if there are multiple, separate with semicolons: a;b;c
WorkflowParams.N	No	Array of ParamInfo	Workflow Parameter List
GeneralTaskParams.N	No	Array of GeneralTaskParam	Specifies configuration optimization parameters (such as threads, memory, and number of CPU cores), which apply to Spark SQL nodes. separate multiple parameters with semicolons.

3. Output Parameters

Parameter Name	Type	Description
Data	Boolean	true indicates success; false indicates failure.
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 Update and Integrate Workflow API

This example shows you how to update the common configuration (basic information & parameters) of the workflow.

Input Example

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

{
    "ProjectId": "1470547050521227264",
    "OperatorName": "kevinnie",
    "WorkflowId": "3dfadfde-af87-11ee-8ec8-b8599f277de5",
    "Owner": "zhanglin",
    "OwnerId": "100028579801",
    "WorkflowDesc": "fd",
    "WorkflowName": "bp_ext_clone_01"
}

Output Example

{
    "Response": {
        "Data": true,
        "RequestId": "947beddf-ecac-472e-8727-fba35e8cb96e"
    }
}

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
FailedOperation	Operation Failure.

Was this page helpful?

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

Yes

Feedback

tencent cloud