文档首页/ 云监控服务 CES/ API参考/ API V3/ Agent任务相关接口/ 批量创建Agent任务
更新时间：2024-10-30 GMT+08:00
查看PDF
分享

批量创建Agent任务

功能介绍

批量创建Agent任务

接口约束

目前拉美-布宜诺斯艾利斯一、拉美-利马一2个局点不支持该接口

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v3/{project_id}/agent-invocations/batch-create

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目id

最小长度：1

最大长度：64

正则匹配：^[a-z0-9]+$

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

发送的实体的MIME类型。默认使用application/json; charset=UTF-8。

缺省值：application/json; charset=UTF-8

最小长度：1

最大长度：64

X-Auth-Token

是

String

用户project Token。用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

最小长度：1

最大长度：16384
表3 请求Body参数

参数

是否必选

参数类型

描述

instance_ids

否

Array of strings

主机id列表（INSTALL和UPDATE时必须）

数组长度：1 - 100

invocation_type

是

String

任务类型，INSTALL 安装，UPDATE升级，ROLLBACK回退，RETRY重试

枚举值：

  • INSTALL

  • UPDATE

  • ROLLBACK

  • RETRY

invocation_target

否

String

任务对象，目前仅支持telescope

缺省值：telescope

枚举值：

  • telescope

invocation_ids

否

Array of strings

任务ID列表（ROLLBACK和RETRY时必须）

数组长度：1 - 100

version_type

否

String

插件升级时需要选择升级“基础版本”还是“增强版本”，传值“BASIC_VERSION”表示升级成基础版本，传值“ADVANCE_VERSION”表示升级成增强版本

枚举值：

  • BASIC_VERSION

  • ADVANCE_VERSION

origin

否

String

Agent任务接口调用源，CES表示由Console调用，APICOM_BMS表示由裸金属服务器调用，ADMIN_SERVER表示由运维平台调用

枚举值：

  • CES

  • APICOM_BMS

  • ADMIN_SERVER

version

否

String

版本号

最小长度：0

最大长度：64

正则匹配：^([0-9A-Za-z]|_|-|\.)+$

响应参数

状态码： 201

表4 响应Body参数

参数

参数类型

描述

invocations

Array of BatchCreateInvocationInfo objects

创建任务的信息列表

数组长度：0 - 100
表5 BatchCreateInvocationInfo

参数

参数类型

描述

instance_id

String

主机id

正则匹配：^[a-zA-Z0-9-]{1,64}$

ret_status

String

任务结果, successful成功，error失败

枚举值：

  • successful

  • error

error_msg

String

错误信息

最小长度：1

最大长度：128

invocation_id

String

任务id

正则匹配：^[a-zA-Z0-9-]{1,64}$

error_code

String

错误码

正则匹配：^(invocationmgr\.[0-9]{4})$

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

正则匹配：^(taskmgr\.[0-9]{4})$

error_msg

String

错误信息

最小长度：1

最大长度：256

状态码： 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

正则匹配：^(taskmgr\.[0-9]{4})$

error_msg

String

错误信息

最小长度：1

最大长度：256

状态码： 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

正则匹配：^(taskmgr\.[0-9]{4})$

error_msg

String

错误信息

最小长度：1

最大长度：256

状态码： 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

正则匹配：^(taskmgr\.[0-9]{4})$

error_msg

String

错误信息

最小长度：1

最大长度：256

请求示例

{
  "instance_ids" : [ "instancexxx001", "instancexxx002" ],
  "invocation_type" : "INSTALL",
  "invocation_target" : "telescope"
}

响应示例

状态码： 201

Created

[ {
  "instance_id" : "instancexxx001",
  "ret_status" : "successful"
}, {
  "instance_id" : "instancexxx002",
  "ret_status" : "error",
  "error_msg" : "do not meet the installation conditions"
} ]

状态码

状态码

描述

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

错误码

请参见错误码。