You can call SuspendFlow operation to suspend a workflow.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. You can use OpenAPI Explorer to search for API operations, call API operations, and dynamically generate SDK sample code.

Request parameters

Parameter Type Required Example Description
Action String Yes SuspendFlow

The operation that you want to perform. This parameter is required for API requests that you create by piecing together HTTP or HTTPS URLs. Set the value to SuspendFlow.

FlowInstanceId String Yes FI-9DDAAA3ADA5F****

The ID of the workflow instance. You can call ListFlowInstance View the workflow ID.

ProjectId String Yes FP-3535FE0BE522****

The ID of the project. You can call ListFlowProject View the ID of the project.

RegionId String Yes cn-hangzhou

The ID of the region to which the cluster belongs. You can call DescribeRegions To view the latest list of Alibaba Cloud regions.

Response parameters

Parameter Type Example Description
Data Boolean true

The execution results are returned, including the following:

  • true: the workflow is successfully paused.
  • false: The workflow fails to be paused.
RequestId String B46F8A2A-B46B-415C-8A9C-B01B99B775A2

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=SuspendFlow
&FlowInstanceId=FI-9DDAAA3ADA5F****
&ProjectId=FP-3535FE0BE522****
&RegionId=cn-hangzhou
&<common request parameters>

Sample success responses

XML format

<SuspendFlowResponse>
  <RequestId>B46F8A2A-B46B-415C-8A9C-B01B99B775A2</RequestId>
      <Data>true</Data>  
</SuspendFlowResponse>

JSON Syntax

{
        "RequestId": "B46F8A2A-B46B-415C-8A9C-B01B99B775A2",
        "Data": true
}

Error code

The port number of a client that accesses a Error CenterFor more information, see error codes.