查询Agent任务列表

project_id

是

String

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

约束限制:

不涉及

取值范围:

长度为[1,64]个字符

默认取值:

不涉及

最小长度：1

最大长度：64

instance_id

否

String

参数解释:

主机id

约束限制:

不涉及

取值范围:

1到64个字符的字符串，且只包含字母、数字和连字符

默认取值:

不涉及

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

instance_type

否

String

参数解释:

主机类型，仅支持ECS弹性云服务器和BMS裸金属服务器

约束限制:

不涉及

取值范围:

• ECS: 弹性云服务器

• BMS：裸金属服务器

默认取值:

不涉及

枚举值：

• ECS

• BMS

invocation_id

否

String

参数解释:

任务id

约束限制:

不涉及

取值范围:

以字母或数字开头，后续可包含字母、数字、下划线或连字符的字符串，长度至少为 1

默认取值:

不涉及

正则匹配：^([0-9A-Za-z]){1}([0-9A-Za-z]|_|-)*$

invocation_type

否

String

参数解释:

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

约束限制:

不涉及。

取值范围:

• INSTALL：安装

• UPDATE：升级

• ROLLBACK：回退

• RETRY：重试

• SET_REMOTE_INSTALLER：设置远程安装主机

• REMOTE_INSTALL：执行远程安装

默认取值:

不涉及

枚举值：

• INSTALL

• UPDATE

• ROLLBACK

• RETRY

• SET_REMOTE_INSTALLER

• REMOTE_INSTALL

invocation_target

否

String

参数解释:

任务对象, 支持telescope监控

约束限制:

不涉及。

取值范围:

• telescope: 主机监控插件telescope

默认取值:

telescope。

缺省值：telescope

枚举值：

• telescope

offset

否

Long

参数解释:

分页偏移量

约束限制:

不涉及

取值范围:

数字范围为[0,9999999999999]

默认取值:

0

最小值：0

最大值：9999999999999

缺省值：0

limit

否

Integer

参数解释:

分页大小。

约束限制:

不涉及。

取值范围:

数字范围为[1,100]

默认取值:

100

最小值：1

最大值：100

缺省值：100

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

invocations

Array of InvocationInfo objects

任务列表

数组长度：0 - 100

count

Long

任务列表总量

最小值：0

最大值：9999999999999

invocation_id

String

任务id

正则匹配：^([0-9A-Za-z]){1}([0-9A-Za-z]|_|-)*$

instance_id

String

主机id

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

instance_name

String

主机名称

最小长度：1

最大长度：128

instance_type

String

主机类型，ECS弹性云服务器，BMS裸金属服务器

枚举值：

• ECS

• BMS

intranet_ips

Array of strings

内网ip列表

数组长度：0 - 10

elastic_ips

Array of strings

弹性公网ip列表

数组长度：0 - 10

invocation_type

String

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

枚举值：

• INSTALL

• UPDATE

• ROLLBACK

• RETRY

invocation_status

String

任务状态，PENDING 待执行，RUNNING 运行中，TIMEOUT 超时，FAILED 失败，SUCCEEDED 成功，CANCELED 取消，ROLLBACKED已回退

枚举值：

• PENDING

• RUNNING

• TIMEOUT

• FAILED

• SUCCEEDED

• CANCELED

• ROLLBACKED

invocation_target

String

任务对象，目前支持telescope

枚举值：

• telescope

create_time

Long

任务创建时间

最小值：1111111111111

最大值：9999999999999

update_time

Long

任务更新时间

最小值：1111111111111

最大值：9999999999999

current_version

String

当前版本

最小长度：1

最大长度：64

target_version

String

目标版本

最小长度：1

最大长度：64

result_msg

String

任务执行结果信息

最小长度：1

最大长度：5000

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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error