根据 ID 批量部署服务
已废弃于 V1.3.0
此接口用于根据资源模板 ID 列表批量部署或预部署服务。如果某个资源模板已部署,系统会根据模板名称找到已部署的服务,并使用当前模板信息更新此服务的部署信息。
接口描述
通信协议:HTTP
URL:POST /api/v1/service/:action/templates-ids
传参方式:body、path
请求参数
字段名 | 类型 | 是否必填 | 说明 | 字段位置 |
---|---|---|---|---|
ids | string[ ] | 是 | 模板 ID 列表 | body |
force | boolean | 否 | 是否强制更新已部署的服务 | body |
action | string | 是 | 部署或预部署,run 代表部署,load 代表预部署 | path |
响应参数
响应参数 data 字段为 DeployResult[ ],若为空则代表着没有资源模板与输入匹配到。
DeployResult
字段名 | 类型 | 说明 |
---|---|---|
provisionTmpld | string | 模板 ID |
result | string | 模板的部署结果。failed 代表部署失败,created 代表已创建部署任务,updated 代表已更新部署任务 |
provisionId | string | null | 模板部署成功后,新建服务的 ID |
tasks | object[ ] | 部署成功后,返回相关的任务信息。 tasks[ ].id 可用于之后查询该服务下实例的部署进度 |
error | string | null | 部署失败,返回错误信息 |
请求示例
curl --location --request POST 'http://localhost:3001/api/v1/service/run/templates-ids' \
--header 'Content-Type: application/json' \
--data-raw '{
"ids":["dd93f8dfbe224ec1a19e26a5a95ac8f3","44c49916b77a4ea684e149dceb50fb37"]
}'
响应示例
{
"status": 200,
"message": "success",
"fieldErrors": null,
"data": [
{
"provisionTmplId": "dd93f8dfbe224ec1a19e26a5a95ac8f3",
"provisionId": null,
"tasks": [],
"result": "failed",
"error": "镜像ID不存在"
},
{
"provisionTmplId": "44c49916b77a4ea684e149dceb50fb37",
"provisionId": null,
"tasks": [],
"result": "failed",
"error": "镜像ID不存在"
}
]
}
错误码
具体请参见 错误码说明。