All Products
Search

This Product

    CloudOps Orchestration Service:NotifyExecution

    Document Center

    CloudOps Orchestration Service:NotifyExecution

    Last Updated:Mar 03, 2024

    Notifies an execution in the Waiting state of the subsequent operations.

    Operation description

    You can call this operation to notify an execution in the following scenarios:

    • If a template contains a special task, such as an approval task, the Operation Orchestration Service (OOS) execution engine sets the execution state to Waiting when the approval task is being run. You can call this operation to specify whether to continue the execution.
    • If you perform debugging in the debug mode, you can call this operation to notify the execution of the subsequent operations after the execution is created or a task is complete.
    • If a high-risk operation task waits for approval, you can call this operation to specify whether to continue the execution.

    Debugging

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

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    oos:NotifyExecutionWrite
    • execution
      acs:oos:{#regionId}:{#accountId}:execution/{#executionId}
    • oos:tag
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringNo

    The ID of the region in which the execution resides.

    		cn-hangzhou
    ExecutionIdstringYes

    The ID of the execution.

    		exec-xxx
    NotifyTypestringYes

    The type of the notification. Valid values:

    • ExecuteTask: starts to run a specific task. This value is used if you perform debugging in the Debug mode. If you set this parameter to ExecuteTask, you also need to set the Parameters parameter.
    • CancelTask: cancels a current task. This value is used if you perform debugging in the Debug mode.
    • CompleteExecution: manually terminates an execution if you perform debugging in the Debug mode. You can specify the state of the terminated execution by using the ExecutionStatus parameter.
    • Approve: approves an execution. For example, you are aware of the risks of an operation task and agree to approve the execution.
    • Reject: rejects an execution. For example, you want to reject the execution of a high-risk operation task.
    • RetryTask: retries a failed task whose execution mode is Suspend upon Failure.
    • SkipTask: skips a failed task whose execution mode is Suspend upon Failure.
    		Approve
    NotifyNotestringNo

    The description for the notification.

    		Note
    TaskNamestringNo

    The name of the subsequent task.

    		describeInstance
    TaskExecutionIdstringNo

    The execution ID of the task.

    		task-exec-xxx
    ExecutionStatusstringNo

    The state of the terminated execution. This parameter is valid if you set the NotifyType parameter to CompleteExecution.

    		Success
    ParametersstringNo

    The parameters of the subsequent task. This parameter is valid if you set the NotifyType parameter to ExecuteTask.

    		{}
    LoopItemstringNo

    The items of the child node in the loop task.

    		i-xxx
    TaskExecutionIdsstringNo

    The execution IDs of the tasks.

    		["exec-79c321c11003a97c","exec-79c321c11003aqw97cz"]

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		491DF8C2-34C9-4679-9DB3-4C0F49B129AC

    Examples

    Sample success responses

    JSONformat

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

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    2023-08-04The internal configuration of the API is changed, but the call is not affectedsee changesets
    Change itemChange content
    The internal configuration of the API is changed, but the call is not affected.