文档首页/ 云监控服务 CES/ API参考/ API/ 云资源监控/ Agent任务相关接口/ 查询Agent任务列表 - ListAgentInvocations
更新时间：2025-11-20 GMT+08:00
查看PDF
分享

查询Agent任务列表 - ListAgentInvocations

功能介绍

查询Agent任务列表

接口约束

目前拉美-布宜诺斯艾利斯一、拉美-利马一2个局点不支持该接口。该接口仅支持查询3个月内的Agent任务列表。

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    ces:agent:listTaskInvocations

    List

    -

    -
    • ces:taskInvocation:get

    -

URI

GET /v3/{project_id}/agent-invocations

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

约束限制:

不涉及

取值范围:

长度为[1,64]个字符

默认取值:

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

instance_id

否

String

参数解释:

主机id

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

instance_type

否

String

参数解释:

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

约束限制:

不涉及

取值范围:

  • ECS: 弹性云服务器

  • BMS：裸金属服务器

默认取值:

不涉及

invocation_id

否

String

参数解释:

任务id

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

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

默认取值:

telescope。

offset

否

Long

参数解释:

分页偏移量

约束限制:

不涉及

取值范围:

数字范围为[0,9999999999999]

默认取值:

0

limit

否

Integer

参数解释:

分页大小。

约束限制:

不涉及。

取值范围:

数字范围为[1,100]

默认取值:

100

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

否

String

参数解释:

发送的实体的MIME类型

约束限制:

不涉及。

取值范围:

长度为[1,64]个字符

默认取值:

application/json; charset=UTF-8

X-Auth-Token

否

String

参数解释:

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

约束限制:

不涉及。

取值范围:

长度为[1,16384]个字符

默认取值:

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

invocations

Array of InvocationInfo objects

参数解释:

任务列表

count

Long

参数解释:

任务列表总量

取值范围:

数字范围为[0,9999999999999]
表5 InvocationInfo

参数

参数类型

描述

invocation_id

String

参数解释:

任务id

取值范围:

以字母或数字开头，后续可以包含字母、数字、下划线（_）或连字符（-），长度至少为1，且不允许出现其他字符

instance_id

String

参数解释:

主机id

取值范围:

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

instance_name

String

参数解释:

主机名称

取值范围:

字符串长度范围为[1,128]

instance_type

String

参数解释:

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

取值范围:

  • ECS: 弹性云服务器

  • BMS：裸金属服务器

intranet_ips

Array of strings

参数解释:

内网ip列表

elastic_ips

Array of strings

参数解释:

弹性公网ip列表

invocation_type

String

参数解释:

任务类型

取值范围:

  • INSTALL：安装

  • UPDATE：升级

  • ROLLBACK：回滚

  • RETRY：重试

invocation_status

String

参数解释:

任务状态

取值范围:

  • PENDING：待执行

  • RUNNING：运行中

  • TIMEOUT：超时

  • FAILED：失败

  • SUCCEEDED：成功

  • CANCELED：取消

  • ROLLBACKED：已回退

invocation_target

String

参数解释:

任务对象, 支持telescope监控

取值范围:

  • 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]

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码：401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码：403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码：500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

无

响应示例

状态码：200

OK

{
  "invocations" : [ {
    "invocation_id" : "invocationxxx001",
    "instance_id" : "instancexxx001",
    "instance_name" : "xxxx",
    "instance_type" : "ECS",
    "intranet_ips" : [ "10.xxx.xx.1" ],
    "elastic_ips" : [ "1.xx.xx.1" ],
    "invocation_type" : "INSTALL",
    "invocation_status" : "RUNNING",
    "invocation_target" : "telescope",
    "current_version" : "2.5.1",
    "target_version" : "2.6.1",
    "create_time" : 1678070008306,
    "update_time" : 1678070008306,
    "result_msg" : "xxx"
  } ],
  "count" : 1
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

错误码

请参见错误码。

相关文档