tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyWorkflowInfo

Last updated: 2024-06-21 15:10:05

1. API Description

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

Update Workflow Information

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: ModifyWorkflowInfo.
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.
ProjectId Yes String Project ID
WorkflowId Yes String Workflow ID
Owner No String Person in Charge
OwnerId No String Responsible Person ID
WorkflowDesc No String Remarks
WorkflowName No String Workflow name
FolderId No String Parent Folder ID
UserGroupId No String Workflow User Group ID If multiple, separated by semicolons: a;b;c
UserGroupName No String Workflow User Group Name If multiple, separated by semicolons: a;b;c
WorkflowParams.N No Array of ParamInfo Workflow Parameter List
GeneralTaskParams.N No Array of GeneralTaskParam Used to configure optimized parameters (Thread, Memory, CPU Core Count, etc.), applicable only to Spark SQL Node. Separate multiple parameters with English 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 Workflow Information Example

Update Workflow Information

Input Example

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

{
    "WorkflowId": "34e51bc4-0cd9-11ed-8909-bc97e105ba60",
    "WorkflowName": "Test Workflow",
    "UserGroupName": "",
    "WorkflowParams": [
        {
            "ParamValue": "11",
            "ParamKey": "ff"
        }
    ],
    "GeneralTaskParams": [
        {
            "Type": "SPARK_SQL",
            "Value": "cc"
        }
    ],
    "ProjectId": "1",
    "WorkflowDesc": "ccc",
    "UserGroupId": "1",
    "Owner": "jack",
    "OwnerId": "104293423",
    "FolderId": "sdf-ddsef-oge923"
}

Output Example

{
    "Response": {
        "RequestId": "f13c9348-c817-4ff0-b747-1c7581862281",
        "Data": true
    }
}

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

6. Error Code

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy