根据 ID 批量更新模板镜像
此接口用于根据模板 ID 批量更新模板镜像。批量更新模板镜像需要逐一指定待修改的模板，一个模板中目前仅支持配置一个容器镜像。 更新模板镜像不会更新镜像之前配置的启动参数，需要用户确保更新前后两个镜像启动参数的兼容问题。更新时支持根据参数选择是否在更新后对模板进行部署操作。
接口描述
通信协议：HTTP
URL：PUT /api/v1/provision-templates
传参方式：body
请求参数
| 字段名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| templates | Template[ ] | 是 | 需要更新的模板数组 |
| action | enum | 否 | 指定在更新后对所有模板进行的部署行为，如果不指定则仅做更新操作 run: 运行 load: 仅创建 |
Template
| 字段名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| id | string | 是 | 需要更新的模板 ID |
| imageRef | string | 是 | 模板 ID 对应的镜像，格式为 name@tag#os |
| action | enum | 否 | 指定在更新后对当前模板进行的部署行为，如果不指定则仅做更新操作，优先级大于上层 run: 运行 load: 仅创建 |
响应参数
响应体 data 字段为数组，其中每一项类型如下
| 字段名 | 类型 | 说明 |
|---|---|---|
| id | string | 模板 ID |
| result | boolean | 更新结果。false 代表失败，true 代表成功 |
| message | string | 如果失败，代表失败的错误信息。如果成功，则为 successful |
| deployResult? | DeployResult | 部署结果 |
请求示例
curl --location --request PUT 'http://localhost:3001/api/v1/provision-templates' \
--header 'Content-Type: application/json' \
--data-raw '{
"templates": [
{
"id": "27d151dc2d6549e18876b8a32f4d9238",
"imageRef": "nginx@1.0.1#linux"
},
{
"id": "05b3a79b7cb44e12be3bb0f13f4da62e",
"imageRef": "redis@1.0.3#linux"
},
{
"id": "f6f8c5131c654c20b4e1ce5058d8b48c-unexisted-id",
"imageRef": "mysql@1.0.5#linux"
}
]
}'
响应示例
{
"status": 200,
"message": "success",
"data": [
{
"id": "27d151dc2d6549e18876b8a32f4d9238",
"result": true,
"message": "successful"
},
{
"id": "05b3a79b7cb44e12be3bb0f13f4da62e",
"result": true,
"message": "successful"
},
{
"id": "f6f8c5131c654c20b4e1ce5058d8b48c-unexisted-id",
"result": false,
"message": "not exist with id",
"message": "successful"
}
],
"fieldErrors": null
}
错误码
具体请参见 错误码说明。
京公网安备11010802043204号