批量创建Agent任务
功能介绍
批量创建Agent任务
接口约束
目前拉美-布宜诺斯艾利斯一、拉美-利马一2个局点不支持该接口
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v3/{project_id}/agent-invocations/batch-create
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目id 最小长度:1 最大长度:64 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
instance_ids |
否 |
Array of strings |
主机id列表(INSTALL和UPDATE时必须) 数组长度:1 - 100 |
invocation_type |
是 |
String |
任务类型,INSTALL 安装,UPDATE升级,ROLLBACK回退,RETRY重试,SET_REMOTE_INSTALL_HOST设置远程安装主机,REMOTE_INSTALL执行远程安装 枚举值: |
invocation_target |
否 |
String |
任务对象,目前仅支持telescope 缺省值:telescope 枚举值: |
invocation_ids |
否 |
Array of strings |
任务ID列表(ROLLBACK和RETRY时必须) 数组长度:1 - 100 |
version_type |
否 |
String |
插件升级时需要选择升级“基础版本”还是“增强版本”,传值“BASIC_VERSION”表示升级成基础版本,传值“ADVANCE_VERSION”表示升级成增强版本 枚举值: |
origin |
否 |
String |
Agent任务接口调用源,CES表示由Console调用,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 |
响应参数
状态码:201
参数 |
参数类型 |
描述 |
---|---|---|
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失败 枚举值: |
error_code |
String |
错误码 正则匹配:^(invocationmgr\.[0-9]{4})$ |
error_msg |
String |
错误信息 最小长度:1 最大长度:128 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 正则匹配:^(taskmgr\.[0-9]{4})$ |
error_msg |
String |
错误信息 最小长度:1 最大长度:256 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 正则匹配:^(taskmgr\.[0-9]{4})$ |
error_msg |
String |
错误信息 最小长度:1 最大长度:256 |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 正则匹配:^(taskmgr\.[0-9]{4})$ |
error_msg |
String |
错误信息 最小长度:1 最大长度:256 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
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 |
错误码
请参见错误码。