DisableWorkflow

Last updated: 2020-01-13 11:41:50

1. API Description

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

This API is used to disable a workflow.

A maximum of 20 requests can be initiated per second for this API.

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 parameter. The value used for this API: DisableWorkflow
Version Yes String Common parameter. The value used for this API: 2019-06-12
Region No String Common parameter. 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, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1

Input Example

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

Output Example

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

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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.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.