批量创建Agent任务

project_id

是

String

参数解释:租户ID。用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取方式请参见“获取项目ID”。取值范围: 字符串的长度必须在 1 到 64个字符之间。

约束限制:

不涉及

取值范围:

长度为[1,64]个字符

默认取值:

不涉及

最小长度：1

最大长度：64

Content-Type

否

String

参数解释:

发送的实体的MIME类型

约束限制:

不涉及。

取值范围:

长度为[1,64]个字符

默认取值:

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

instance_ids

否

Array of strings

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

数组长度：1 - 100

invocation_type

是

String

任务类型，INSTALL 安装，UPDATE升级，ROLLBACK回退，RETRY重试，SET_REMOTE_INSTALLER设置远程安装主机，REMOTE_INSTALL执行远程安装

枚举值：

• INSTALL

• UPDATE

• ROLLBACK

• RETRY

• SET_REMOTE_INSTALLER

• REMOTE_INSTALL

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]|_|-|\.)+$

remote_install_meta

否

Array of RemoteInstallHostInfo objects

创建远程安装任务时需要下发的被安装主机相关信息

数组长度：0 - 100

instance_name

否

String

被远程安装的主机名称

最小长度：1

最大长度：128

remote_ip

否

String

被远程安装的主机IP

正则匹配：^(([0-9]|\.){1,15})$

user_name

否

String

被远程安装的主机的登录用户名

最小长度：1

最大长度：16

port

否

String

被远程安装的主机的登录端口

最小长度：1

最大长度：5

password

否

String

被远程安装的主机的登录密码

最小长度：1

最大长度：3000

remote_use_pem

否

Boolean

被远程安装的主机远程连接是否采用密钥方式（false时为密码方式）

缺省值：false

invocations

Array of BatchCreateInvocationInfo objects

创建任务的信息列表

数组长度：0 - 100

instance_id

String

机器id

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

invocation_id

String

任务id

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

ret_status

String

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

枚举值：

• successful

• error

error_code

String

错误码

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

error_msg

String

错误信息

最小长度：1

最大长度：128

error_code

String

错误码

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

error_msg

String

错误信息

最小长度：1

最大长度：256

error_code

String

错误码

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

error_msg

String

错误信息

最小长度：1

最大长度：256

error_code

String

错误码

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

error_msg

String

错误信息

最小长度：1

最大长度：256

error_code

String

错误码

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

error_msg

String

错误信息

最小长度：1

最大长度：256

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error