NotifyExecution - OOS API - CloudOps Orchestration Service

Notifies a waiting execution how to proceed.

Operation description

When a template contains a special task such as an approval task, OOS sets the execution state to Waiting while the task runs.
In Debug mode, call this operation to specify the next task after an execution is created or a task completes.
When a high-risk task awaits approval, call this operation to approve or reject the execution.

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

oos:NotifyExecution

update

*execution

acs:oos:{#regionId}:{#accountId}:execution/{#executionId}

oos:tag
oos:TLSVersion

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	Region where the execution resides.	cn-hangzhou
ExecutionId	string	Yes	Execution ID.	exec-xxx
NotifyType	string	Yes	Notification type. Valid values: ExecuteTask: starts a specific task in Debug mode. Requires the Parameters parameter. CancelTask: cancels the current task in Debug mode. CompleteExecution: terminates the execution in Debug mode. Use ExecutionStatus to set the final state. Approve: approves the execution to continue. Reject: rejects the execution. RetryTask: retries a failed task in Suspend upon Failure mode. SkipTask: skips a failed task in Suspend upon Failure mode.	Approve
NotifyNote	string	No	Notification description.	Approved
TaskName	string	No	Name of the next task to run.	describeInstance
TaskExecutionId	string	No	Task execution ID.	task-exec-xxx
ExecutionStatus	string	No	Final state of the terminated execution. Valid only when NotifyType is set to CompleteExecution.	Success
Parameters	string	No	Parameters for the next task. Valid only when NotifyType is set to ExecuteTask.	{}
LoopItem	string	No	Child node items in a loop task.	i-xxx
TaskExecutionIds	string	No	Task execution IDs.	["exec-79c321c11003a97c","exec-79c321c11003aqw97cz"]

Response elements

Element	Type	Description	Example
	object
RequestId	string	Request ID.	491DF8C2-34C9-4679-9DB3-4C0F49B129AC

Examples

Success response

JSON format

{
  "RequestId": "491DF8C2-34C9-4679-9DB3-4C0F49B129AC"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.