NotifyExecution - 通知执行如何运行

通知一个状态为等待中的执行接下来如何运行。

接口说明

有以下情况可以被通知:

  • 特殊任务执行等待审批时,即模版中有Approve任务,模版执行到Approve对应的任务时,执行切换为等待中状态,可通过该Api确认是否继续执行。
  • Debug模式下调试时,执行创建后或完成一个任务执行后,用该API指定接下来进行的任务执行。
  • 高风险操作类任务执行等待审批时,可通过该Api确认是否继续执行。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用加粗字体表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
oos:NotifyExecutionWRITE
  • OOS
    acs:oos:{#regionId}:{#accountId}:execution/{#executionId}
  • oos:tag

请求参数

名称类型必填描述示例值
RegionIdstring

地域ID

cn-hangzhou
ExecutionIdstring

执行ID

exec-xxx
NotifyTypestring

通知类型。取值范围:

  • Approve- 同意,适用于批准待审批的执行。如已知晓高危操作的任务执行风险,并准许其执行。
  • Reject - 拒绝,适用于驳回待审批的执行。如不准许高危操作的任务执行。
  • ExecuteTask - 指定某个任务执行的开始,适用于Debug模式。可能需配合Parameters参数。
  • CancelTask - 取消当前的任务执行,适用于Debug模式。
  • CompleteExecution - 手动终止一个Debug模式下的执行。可配合ExecutionStatus参数指定被终止执行的状态。
Approve
NotifyNotestring

用于说明的message

说明
TaskNamestring

下一步要执行的Task Name

describeInstance
TaskExecutionIdstring

任务执行ID

task-exec-xxx
ExecutionStatusstring

适用于CompleteExecution

Success
Parametersstring

适用于ExecuteTask

{}
LoopItemstring

Loop子节点对应Item数据

i-xxx
TaskExecutionIdsstring

任务执行的ID列表。

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

返回参数

名称类型描述示例值
object
RequestIdstring

请求ID

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

示例

请求示例

http(s)://oos.cn-hangzhou.aliyuncs.com/?Action=NotifyExecution
&ExecutionId=exec-xxx
&NotifyType=Approve
&<公共请求参数>

正常返回示例

JSON格式

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

XML格式

<NotifyExecutionResponse>
    <RequestId>491DF8C2-34C9-4679-9DB3-4C0F49B129AC</RequestId>
</NotifyExecutionResponse>

错误码

访问错误中心查看更多错误码。

阿里云首页 运维编排服务 相关技术圈