NotifyExecution - OOS API - CloudOps Orchestration Service

Notifies a waiting execution of how to proceed.

Operation description

The following scenarios support notifications:

When a special task execution is waiting for approval. If a template contains an Approve task and the execution reaches the Approve task, the execution switches to the Waiting state. You can call this API operation to confirm whether to continue to execute.
When debugging in Debug mode. After an execution is created or a task execution is completed, call this API operation to specify the next task execution.
When a risky operation task execution is waiting for approval. You can call this API operation to confirm whether to continue to execute.

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	The region ID.	cn-hangzhou
ExecutionId	string	Yes	The execution ID.	exec-xxx
NotifyType	string	Yes	The notification type. Valid values: ExecuteTask: starts a specified task execution. This value is applicable to Debug mode. You may need to specify the Parameters parameter. CancelTask: cancels the current task execution. This value is applicable to Debug mode. CompleteExecution: manually terminates an execution in Debug mode. You can use the ExecutionStatus parameter to specify the status of the terminated execution. Approve: approves a pending execution. For example, you are aware of the risks of a high-risk operation task execution and approve the execution. Reject: rejects a pending execution. For example, you do not approve a high-risk operation task execution. RetryTask: retries a failed task execution. This value is applicable to the failure-pause mode. SkipTask: skips a failed task execution. This value is applicable to the failure-pause mode.	Approve
NotifyNote	string	No	The notification message for description purposes.	Description
TaskName	string	No	The name of the next task to execute.	describeInstance
TaskExecutionId	string	No	The task execution ID.	task-exec-xxx
ExecutionStatus	string	No	The execution status. This parameter is applicable to CompleteExecution.	Success
Parameters	string	No	The parameters. This parameter is applicable to ExecuteTask.	{}
LoopItem	string	No	The item data corresponding to the loop child node.	i-xxx
TaskExecutionIds	string	No	The list of task execution IDs.	["exec-79c321c11003a97c","exec-79c321c11003aqw97cz"]

Response elements

Element	Type	Description	Example
	object
RequestId	string	The 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.