You can call this operation to suspend a workflow.

Request parameters

Parameter Type Required Example Description
FlowInstanceId String Yes FI-9DDAAA3ADA5F6FA2 FI-9DDAAA3ADA5F6FA2
ProjectId String Yes FP-3535FE0BE5224A47 The ID of the project.
RegionId String Yes cn-hangzhou The region location ID.

Response parameters

Parameter Type Example Description
RequestId String B46F8A2A-B46B-415C-8A9C-B01B99B775A2 The ID of the request.
Data Boolean true Indicates whether the workflow is suspended.

Examples

  • Sample requests
    
    /? Action=SuspendFlow
    &FlowInstanceId=FI-9DDAAA3ADA5F6FA2
    &ProjectId=FP-3535FE0BE5224A47
    &RegionId=cn-hangzhou 
    &<Common request parameters>
  • Successful response examples
    JSON format
    {
    	"Data":true,
    	"RequestId":"B46F8A2A-B46B-415C-8A9C-B01B99B775A2"
    }
  • Error response examples
    JSON format
    {
    	"code":"FLOW_API_FAILED",
    	"message":"project not exist",
    	"requestId":"11BAFBD8-8509-4177-A26D-407505E73713",
    	"successResponse":false
    }

Error codes

View error codes.