更新时间:2025-09-30 GMT+08:00
分享

部署回滚

功能介绍

根据部署记录ID执行回滚。

调用方法

请参见如何调用API

URI

POST /v2/tasks/{task_id}/records/{record_id}/rollback

表1 路径参数

参数

是否必选

参数类型

描述

task_id

String

参数解释

部署任务ID。通过调用获取应用详情接口获取(响应体result.arrange_infos[0].id的值)。

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

record_id

String

参数解释

部署记录ID。通过调用根据开始时间和结束时间查询项目下指定应用的历史部署记录列表接口获取(响应体result[0].execution_id的值)。

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制

不涉及。

取值范围

字符串,长度不超过20000个字符。

默认取值

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

RollbackRecordsRequestBody

Object

参数解释

兼容WSF请求体不能为空的要求, 传空JSON对象。

约束限制

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

id

String

参数解释

部署记录ID。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

task_id

String

参数解释

部署任务ID。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

job_name

String

参数解释

作业名称。

取值范围

只能由英文字母、数字组成,长度最大为100个字符。

app_component_list

Array of AppComponentDao objects

参数解释

应用关联组件列表。

表5 AppComponentDao

参数

参数类型

描述

task_id

String

参数解释

部署任务ID。

取值范围

由英文字母、数字组成,且长度为32个字符。

app_id

String

参数解释

AOM应用ID。

取值范围

由英文字母、数字组成,且长度为32个字符。

app_name

String

参数解释

AOM应用名称。

取值范围

由英文字母、数字组成。

comp_id

String

参数解释

AOM应用组件ID。

取值范围

由英文字母、数字组成,且长度为32个字符。

comp_name

String

参数解释

AOM应用组件名称。

取值范围

长度为[0,128]个字符。

domain_id

String

参数解释

租户ID。

取值范围

由英文字母、数字组成,且长度为32个字符。

region

String

参数解释

局点信息。

取值范围

长度为[1,256]个字符。

state

String

参数解释

AOM应用组件是否生效。

取值范围

  • 0: 初始化

  • 1: 执行成功,已生效

请求示例

根据部署记录ID执行回滚。

https://{endpoint}/v2/tasks/a38a2d40162f4ea1aa8c7cebca0bc7f8/records/a99c6b14dbc3449384849f1e7e03ea20/rollback

{ }

响应示例

状态码:200

OK,表示执行回滚成功。

{
  "id" : "a99c6b14dbc3449384849f1e7e03ea20",
  "task_id" : "a38a2d40162f4ea1aa8c7cebca0bc7f8",
  "job_name" : "job_a99c6b14dbc3449384849f1e7e03ea20_1758844038197",
  "app_component_list" : [ {
    "task_id" : "a38a2d40162f4ea1aa8c7cebca0bc7f8",
    "app_id" : "000e3dce512a459c929eb54f6f3a88ac",
    "app_name" : "App-202410302024685",
    "comp_id" : "00138c1d6f9d493597091bda6c6ae4fa",
    "comp_name" : "服务关联组件",
    "domain_id" : "ce8df55870164338a72d7e828a966a2a",
    "region" : "example-region",
    "state" : "1"
  } ]
}

状态码

状态码

描述

200

OK,表示执行回滚成功。

错误码

请参见错误码

相关文档