文档首页/应用运维管理 AOM/API参考（安卡拉区域）/API/Agent/查询Agent信息
更新时间：2024-04-15 GMT+08:00
查看PDF
分享

查询Agent信息

功能介绍

查询对应账号、集群、命名空间下的Agent信息。

URI

GET /v1/{project_id}/{cluster_id}/{namespace}/agents

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户从IAM申请到的projectid，一般为32位字符串。

cluster_id

是

String

集群ID

namespace

是

String

命名空间

表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

分页信息

limit

否

Integer

默认值为1000。用于限制结果数据条数。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

从IAM服务获取的用户Token。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

page_info

PageInfo object

查询结果元数据信息，包括分页信息等

agent_list

Array of AgentDetail objects

查询agent列表

表5 PageInfo

参数

参数类型

描述

count

Integer

当前返回结果条数

offset

Integer

下一个开始的标记，用于分页，null表示无更多数据

total

Integer

总条数

表6 AgentDetail

参数

参数类型

描述

agent_id

String

Agent 自身id，用于标明agent,必选

agent_ip

String

icagent 所在节点私有ip,必选

node_name

String

icagent 所在节点名称,必选

status

String

icagent 运行状态,必选

last_modified

String

icagent 上次修改时间,必选

update_time

String

icagent 上次升级时间,必选

agent_version

String

icagent 版本号,必选

os_type

String

icagent 所在节点os类型,必选

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

调用失败响应信息描述

状态码： 401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

调用失败响应信息描述

状态码： 403

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

调用失败响应信息描述

状态码： 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

调用失败响应信息描述

状态码： 503

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

调用失败响应信息描述

请求示例

查询用户75f54********0cbd0c4下的集群ID为0f325*******00cb，namespace为default的agent信息。

GET https://{endpoint}/v1/75f54********0cbd0c4/0f325*******00cb/default/agents?offset=50&limit=789

响应示例

状态码： 200

OK

请求响应成功。

{
  "page_info" : {
    "count" : 2,
    "offset" : 0,
    "total" : 2
  },
  "agent_list" : [ {
    "agent_ip" : "192.***.***.102",
    "agent_id" : "8977a034********473f6ef642",
    "node_name" : "192.***.***.102",
    "status" : "uninstall",
    "last_modified" : "",
    "update_time" : "",
    "agent_version" : "",
    "os_type" : ""
  }, {
    "agent_ip" : "192.***.***.133",
    "agent_id" : "6211b62********a6d1389e233",
    "node_name" : "192.***.***.133",
    "status" : "uninstall",
    "last_modified" : "",
    "update_time" : "",
    "agent_version" : "",
    "os_type" : ""
  } ]
}

状态码

状态码

描述

200

OK

请求响应成功。

400

BadRequest

非法请求。建议直接修改该请求，不要重试该请求。

401

Unauthorized

在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。

403

Forbidden

请求被拒绝访问。返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。

500

InternalServerError

表明服务端能被请求访问到，但是不能理解用户的请求。

503

ServiceUnavailable

被请求的服务无效。建议直接修改该请求，不要重试该请求。

错误码

请参见错误码。

父主题：Agent