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

查询Agent任务列表

功能介绍

查询Agent任务列表

接口约束

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

调试

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

URI

GET /v3/{project_id}/agent-invocations

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目id

最小长度：1

最大长度：64

正则匹配：^[a-z0-9]+$
表2 Query参数

参数

是否必选

参数类型

描述

instance_id

否

String

主机id

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

instance_type

否

String

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

枚举值：

  • ECS

  • BMS

invocation_id

否

String

任务id

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

invocation_type

否

String

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

枚举值：

  • INSTALL

  • UPDATE

  • ROLLBACK

  • RETRY

invocation_target

否

String

任务对象，目前仅支持telescope

缺省值：telescope

枚举值：

  • telescope

offset

否

Long

分页偏移量

最小值：0

最大值：9999999999999

缺省值：0

limit

否

Integer

分页大小

最小值：1

最大值：100

缺省值：100

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

最小长度：1

最大长度：16384

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

invocations

Array of InvocationInfo objects

任务列表

数组长度：0 - 100

count

Long

任务列表总量

最小值：0

最大值：9999999999999
表5 InvocationInfo

参数

参数类型

描述

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

状态码： 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

请求示例

无

响应示例

状态码： 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
  } ],
  "count" : 1
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

错误码

请参见错误码。

相关文档