StopExecution - CloudFlow

Stops an execution that is in progress in a flow.

Operation description

Usage notes

The flow must be in progress.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
fnf:StopExecution	update	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
FlowName	string	Yes	The name of the workflow to be stopped. You can call the ListFlows operation to obtain the value of this parameter.	flow
ExecutionName	string	Yes	The name of the execution to be stopped. You can call the ListExecutions operation to obtain the value of this parameter.	exec
Cause	string	No	The reason for stopping the execution. The value must be 1 to 4,096 characters in length.	for test
Error	string	No	The error code for stopping the execution. The error code must be 1 to 128 characters in length.	nill

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
Status	string	The execution status. Valid values: Starting Running Stopped Succeeded Failed TimedOut	Running
StoppedTime	string	The time when the execution stopped.	2019-01-01T01:01:01.001Z
RequestId	string	The request ID.	testRequestId
StartedTime	string	The time when the execution started.	2019-01-01T01:01:01.001Z
FlowDefinition	string	The definition of the flow.	version: v1.0\ntype: flow\nname: test\nsteps:\n - type: pass\n name: mypass
Output	string	The execution result, which is in the JSON format.	{"key":"value"}
FlowName	string	The name of the flow.	flow
Name	string	The name of the execution.	exec
Input	string	The input of the execution, which is in the JSON format.	{"key":"value"}

Examples

Sample success responses

JSONformat

{
  "Status": "Running",
  "StoppedTime": "2019-01-01T01:01:01.001Z",
  "RequestId": "testRequestId",
  "StartedTime": "2019-01-01T01:01:01.001Z",
  "FlowDefinition": "version: v1.0\\ntype: flow\\nname: test\\nsteps:\\n - type: pass\\n name: mypass",
  "Output": "{\"key\":\"value\"}",
  "FlowName": "flow",
  "Name": "exec",
  "Input": "{\"key\":\"value\"}",
  "RoleArn": "acs:ram:${region}:${accountID}:${role}"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ActionNotSupported	The requested API operation '%s' is incorrect. Please check.	-
400	APIVersionNotSupported	The requested API version '%s' is not supported yet. Please check.	-
400	EntityTooLarge	The payload size exceeds maximum allowed size (%s bytes).	The payload size exceeds maximum allowed size (%s bytes).
400	ExecutionAlreadyCompleted	Execution '%s' for flow '%s' has already completed.	-
400	InvalidArgument	Parameter error.	Parameter error.
400	MissingRequiredHeader	The HTTP header '%s' must be specified.	The HTTP header '%s' must be specified.
400	MissingRequiredParams	The HTTP query '%s' must be specified.	The HTTP query '%s' must be specified.
403	AccessDenied	The resources doesn't belong to you.	-
403	InvalidAccessKeyID	The AccessKey ID %s is invalid.	The AccessKey ID %s is invalid.
403	RequestTimeTooSkewed	The difference between the request time %s and the current time %s is too large.	The difference between the request time %s and the current time %s is too large.
403	SignatureNotMatch	The request signature we calculated does not match the signature you provided. Check your access key and signing method.	The calculated signature of the request does not match the signature you provided. Check your AccessKey Secret and signing algorithm.
404	ExecutionNotExists	Execution %s for flow %s does not exist.	Execution %s for flow %s does not exist.
404	FlowNotExists	Flow %s does not exist.	Flow %s does not exist.
409	ConcurrentUpdateError	Update conflict, please retry.	Update conflict, please retry.
415	UnsupportedMediaType	The content type must be "application/json".	The content type must be "application/json".
429	ResourceThrottled	The request is throttled. Please try again later.	The request is throttled. Please try again later.
500	InternalServerError	An internal error has occurred. Please retry.	An internal error has occurred. Please retry.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-08-06	The Error code has changed. The response structure of the API has changed	View Change Details
2024-03-21	The Error code has changed. The request parameters of the API has changed	View Change Details