# 根据发布单ID操作发布单 - OperateReleaseTaskBasedOnTheReleaseTaskID #### 功能介绍 此API用来对发布单进行发布、停止、继续等操作。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-servicestage/servicestage_06_0183.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | servicestage:pipeline:modify | write | pipeline \* | - | servicestage:pipeline:execute | - | #### URI POST /v3/{project_id}/pipeline/pipelines/{pipeline_id}/action 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户项目ID。获取方法，请参考[获取项目ID](https://support.huaweicloud.com/api-servicestage/servicestage_06_0164.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | pipeline_id | 是 | String | **参数解释：** 发布单ID。获取方法，请参考[获取发布单列表 - ObtainReleaseTaskList](https://support.huaweicloud.com/api-servicestage/servicestage_06_0246.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表2查询参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | action_id | 是 | String | 操作类型。 - start，启动。 - stop，停止。 - retry，重试。 - approval，审批。 - continue，继续。 - rollback，回滚。 | #### 请求消息 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | Content-Type | 是 | String | **参数解释：** 消息体的类型（格式）。 **约束限制：** 不涉及 **取值范围：** application/json;charset=utf8 **默认取值：** 不涉及 | | X-Auth-Token | 是 | String | **参数解释：** 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考[认证鉴权](https://support.huaweicloud.com/api-servicestage/servicestage_06_0010.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表4请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | selected_tasks | 否 | Array of objects | 需要执行的任务，当"action_id"为"start"时需要但是非必传，若不传或传null表示全部执行，请参考[表5]。 | | task_name | 否 | String | 需要执行的任务名称，当"action_id"为"approval"时必传。 | | approval_type | 否 | String | 审批类型，当"action_id"为"approval"时必传，表示审批同意或者拒绝。 - agree，同意。 - refuse，拒绝。 | | message | 否 | String | 审批信息，当"action_id"为"approval"时需要但是非必传。 | 表5selected_tasks | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | stage_name | 是 | String | 阶段名称。 | | tasks | 是 | Array of strings | 需要执行的任务名称。 | #### 响应消息 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 发布单执行ID。 | | pipeline_id | String | 发布单ID。 | | status | Integer | 发布单状态。 - 1：初始化成功。 - 2：发布成功。 - 3：发布失败。 - 4：发布中。 - 5：待审批。 - 7：暂停。 - 9：跳过。 - 10：回滚中。 - 11：回滚成功。 - 12：回滚失败。 - 13：停止中。 - 14：重启中。 | #### 请求示例 启动发布单。 ``` { "selected_tasks": [ { "stage_name": "899tih", "tasks": [ "ujgdh4" ] }, { "stage_name": "uipfzw", "tasks": [ "ax8hus" ] } ] } ``` #### 响应示例 ``` { "id": 286541, "pipeline_id": "caf409b1-10df-483a-b14d-7b05f7e12c88", "status": 4 } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 操作成功。 | | 400 | 错误的请求。 | | 404 | 请求对象不存在。 | | 500 | 内部错误。 | #### 错误码 请参考[ServiceStage错误码](https://support.huaweicloud.com/api-servicestage/servicestage_06_0162.html)。