tencent cloud

APIs

DocumentaçãoAPIsTencent Cloud DataBuddyWorkflow APIsUpdateWorkflow

UpdateWorkflow

Baixar
Modo Foco
Tamanho da Fonte
Última atualização: 2026-10-11 15:47:57

1. API Description

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

Updating a Workflow

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: UpdateWorkflow.
Version Yes String Common Params. The value used for this API: 2026-07-15.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
WorkspaceId Yes String

Workspace ID, which can be obtained through ListWorkspaces. Required.
WorkflowId Yes String

ID of the workflow to be updated. You can obtain it through ListWorkflows. Required
FieldToRemoveList.N No Array of String

List of field names to be cleared, used to reset the specified fields to empty
NewSetting No Workflow

After the update, only import the parts of the workflow configuration that need to be changed

3. Output Parameters

Parameter Name Type Description
Data UpdateWorkflowRsp

Update workflow response content
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 Modify workflow Git information

Modify workflow Git information

Input Example

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

{
    "WorkspaceId": "17678671667189298",
    "WorkflowId": "8f760036-a086-49cd-9d20-7aa25c8a76be",
    "NewSetting": {
        "GitConfigId": "1785920869632****",
        "GitBranch": "main"
    }
}

Output Example

{
    "Response": {
        "Data": {
            "Status": true
        },
        "RequestId": "bddfebb1-6ad0-482f-b21c-94bd5f2e7010"
    }
}

Example2 Updating a Workflow

Input Example

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

{
    "WorkspaceId": "17697410068842890",
    "WorkflowId": "8e0e3485-2736-4530-92ed-932e019898f1",
    "NewSetting": {
        "TaskList": [
            {
                "ParamList": [],
                "DependOnList": [],
                "TaskName": "py_0807",
                "TaskType": {
                    "TaskTypeName": "PYTHON",
                    "TaskTypePropertyList": [
                        {
                            "PropertyKey": "Source",
                            "PropertyValue": "5"
                        }
                    ],
                    "RuntimePropertyList": [
                        {
                            "PropertyKey": "ResourceMode",
                            "PropertyValue": "1"
                        }
                    ]
                },
                "ResourceGroupId": "res******8f8",
                "TaskRetryStrategy": {},
                "DependOnRunCondition": "ALL_SUCCESS",
                "LeftCoordinate": 50,
                "TopCoordinate": 50
            }
        ]
    }
}

Output Example

{
    "Response": {
        "Data": {
            "Status": true
        },
        "RequestId": "516da81c-51c7-4f90-9cad-8545fb200113"
    }
}

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.
FailedOperation.CallThirdPartApiError Failed to call the <apiName> API of the <serviceName> service: <message>.
FailedOperation.LabelCountLimit Number of tags has reached the upper limit.
FailedOperation.UpdateWorkflowFailed Failed to update workflow
FailedOperation.WorkflowBundleNoPermission This workflow is content deployed through a bundle package. Do not edit this workflow.
FailedOperation.WorkflowCreateLockAcquireFailed Failed to obtain the distributed lock for the workflow name.
FailedOperation.WorkflowNoPermission No operation permissions.
InvalidParameterValue Parameter value error.
InvalidParameterValue.DuplicateTaskNameError Duplicate tasks exist in the same workflow.
InvalidParameterValue.LoopDataArrayElementCountLimit The number of LoopDataArray elements exceeds the upper limit.
InvalidParameterValue.LoopDataArrayJsonInvalid The LoopDataArray value is not a JSON array literal or a {{var}} placeholder expression.
InvalidParameterValue.LoopDataArrayNotJsonArray The LoopDataArray value was successfully parsed, but the top-level node is not a JSON array.
InvalidParameterValue.LoopDataArrayNotJsonArrayLiteral The LoopDataArray value is not a JSON array literal or a {{var}} placeholder expression.
InvalidParameterValue.LoopDataArrayValueBlank The LoopDataArray field in the FOR_EACH task is empty or contains only whitespace.
InvalidParameterValue.LoopDataArrayValueLengthLimit The string length of the LoopDataArray field in the FOR_EACH task exceeds the upper limit.
InvalidParameterValue.LoopDataArrayVariableExpressionInvalid The LoopDataArray variable expression fails to satisfy the placeholder syntax (curly brackets must be paired and not nested).
InvalidParameterValue.ParamIllegalError Parameter <parameter> does not meet requirements: <message>
InvalidParameterValue.TaskHookValidationFailed Referenced object does not exist or has been deleted
InvalidParameterValue.TaskNameContainsIllegalCharactersError Task name contains invalid characters
InvalidParameterValue.TaskNameExceedsLimitError Task name exceeds the maximum number of characters (128).
InvalidParameterValue.TaskTypeNotSupportResourceGroup Remove the resource group configuration of this task type
InvalidParameterValue.TaskTypePropertyKeyValueRequestRequiredError Task type attribute value is required in input parameters, but it is not transmitted.
InvalidParameterValue.WorkflowNameExists Workflow name already exists.
InvalidParameterValue.WorkflowNameInvalid Invalid workflow name.
InvalidParameterValue.WorkflowStartTimeAfterEndTimeError Workflow schedule start time cannot be later than end time.
InvalidParameterValue.WorkflowTriggerAdvancedConfigError Please check the advanced configuration of the workflow trigger and fix the illegal JSON content.
MissingParameter Parameters are missing.
ResourceNotFound The resource does not exist.
ResourceNotFound.WorkflowNotExist Workflow does not exist.
ResourceNotFound.WorkflowNotFound Workflow not found according to the input workflow ID
ResourceNotFound.WorkflowTriggerNotFound Workflow scheduling configuration not found.
Anterior: ListWorkflowsPróximo: DeleteWorkflow

Ajuda e Suporte

Esta página foi útil?

comentários

Search
    Enter keywords to search documentation