tencent cloud

Tencent Cloud WeData

DocumentaçãoTencent Cloud WeDataAPI DocumentationData Development APIsUpdateTriggerWorkflowPartially

UpdateTriggerWorkflowPartially

PDF
Modo Foco
Tamanho da Fonte
Última atualização: 2026-03-02 12:26:49

1. API Description

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

Update workflow (including basic info 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: UpdateTriggerWorkflowPartially.
Version Yes String Common Params. The value used for this API: 2025-08-06.
Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-hongkong, ap-jakarta, ap-singapore, eu-frankfurt, na-ashburn, na-siliconvalley.
ProjectId Yes String Project ID.
WorkflowId Yes String Workflow ID.
NewSetting No UpdateTriggerWorkflowPartially Responsible person ID.
FieldToRemoveList.N No Array of String Delete field content, identify in the form of property path, separate deleted values with ":" and multiple values with ",".
Delete the attributes "WorkflowParams:aa,bb" where ParamKey is aa,bb in the scheduling parameters.
Delete the scheduling configuration with TriggerId "da46d950-d5ca-4cfb-a5a9-f3c2eeea1bf0" in TriggerWorkflowSchedulerConfigurations.
Delete the spark sql general parameter "GeneralTaskParams: spark_sql".

3. Output Parameters

Parameter Name Type Description
Data UpdateTriggerWorkflowResult true represents success, false represents 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 Successful Example

Successful Example

Input Example

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

{
    "ProjectId": "1460947878944567296",
    "WorkflowId": "c6df7416-ee03-405e-adf1-094d26b8c98b",
    "NewSetting": {
        "WorkflowName": "test_wk_3"
    }
}

Output Example

{
    "Response": {
        "Data": {
            "Status": true
        },
        "RequestId": "854f7e7d-9ff7-4a14-b439-54e02f281496"
    }
}

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

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 failed.
InvalidParameter Parameter error.
InvalidParameterValue Parameter value error.
MissingParameter Parameter missing.
Anterior: ListTriggerWorkflowsPróximo: UpdateTriggerWorkflow

Ajuda e Suporte

Esta página foi útil?

comentários