Stop a flow execution with StopExecution - CloudFlow - Alibaba Cloud - CloudFlow

Operation description

Usage notes

The flow must be in progress.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

fnf:StopExecution

update

*All Resource

*

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. Must be 1 to 128 characters in length.	nill

Response elements

Element	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 in JSON format.	{"key":"value"}
FlowName	string	The name of the flow.	flow
Name	string	The name of the execution.	exec
Input	string	The execution input in JSON format.	{"key":"value"}
RoleArn	string	The Alibaba Cloud Resource Name (ARN) of the role used to run the flow. If the RoleArn in the flow definition changes during execution, the system records and returns a snapshot of the original RoleArn. Note If you do not specify the RoleArn parameter in the request parameters, the response parameters do not contain the RoleArn parameter.	acs:ram:${region}:${accountID}:${role}

Examples

Success response

JSON format

{
  "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
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).
400	ExecutionAlreadyCompleted	Execution '%s' for flow '%s' has already completed.
400	InvalidArgument	Parameter error.
400	MissingRequiredHeader	The HTTP header '%s' must be specified.
400	MissingRequiredParams	The HTTP query '%s' must be specified.
500	InternalServerError	An internal error has occurred. Please retry.
403	AccessDenied	The resources doesn't belong to you.
403	InvalidAccessKeyID	The AccessKey ID %s is invalid.
403	RequestTimeTooSkewed	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.
404	ExecutionNotExists	Execution %s for flow %s does not exist.
404	FlowNotExists	Flow %s does not exist.
415	UnsupportedMediaType	The content type must be "application/json".
429	ResourceThrottled	The request is throttled. Please try again later.
409	ConcurrentUpdateError	Update conflict, please retry.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.