DisableWorkflow

Last updated: 2025-10-30 21:51:05Download PDF

1. API Description

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

This API is used to disable 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: DisableWorkflow.
Version	Yes	String	Common Params. The value used for this API: 2019-06-12.
Region	No	String	Common Params. This parameter is not required for this API.
WorkflowId	Yes	Integer	Workflow ID.

3. Output Parameters

Parameter Name	Type	Description
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 Disabling a workflow

This example shows you how to disable the workflow whose ID is 19000.

Input Example

https://mps.intl.tencentcloudapi.com/?Action=DisableWorkflow
&WorkflowId=19000
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3"
    }
}

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.BucketNotifyAlreadyExist	Operation failed: notification has already been set for the bucket.
FailedOperation.CosStatusInavlid	Operation failed: COS service is suspended.
FailedOperation.InvalidMpsUser	Operation failed: unauthorized MPS user.
InternalError	Internal error.
InvalidParameterValue	Incorrect parameter value.
ResourceNotFound.CosBucketNameInvalid	The resource does not exist: invalid COS bucket name.
ResourceNotFound.CosBucketNotExist	The resource does not exist: the COS bucket does not exist.
ResourceNotFound.TemplateNotExist	The resource does not exist: the template does not exist.