插件状态查询 - ListAgentStatus

功能介绍

插件状态查询，包括uniagent状态以及插件状态

调试

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

授权信息

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

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
ces:agent:listStatuses
List
-
-
ces:agentStatus:get
ces:agentStatus:list
-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
ces:agent:listStatuses	List	-	-	ces:agentStatus:get ces:agentStatus:list	-

URI

POST /v3/{project_id}/agent-status/batch-query

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释:项目ID。用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取方式请参见“获取项目ID”。取值范围: 字符串的长度必须在 1 到 64个字符之间。约束限制: 不涉及取值范围: 长度为[1,64]个字符默认取值: 不涉及

请求参数

表2 请求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]个字符默认取值: 不涉及

表3 请求Body参数
参数	是否必选	参数类型	描述
instance_ids	是	Array of strings	参数解释: 机器实例id列表约束限制: 包含的机器实例id最多为2000个，最少为1个
uniagent_status	否	String	参数解释: uniagent运行状态，不传值则查出所有状态约束限制: 不涉及。取值范围: none: 未安装 running: 运行中 silent: 静默状态，用于大规模插件异常时，紧急规避的一种措施，现象是kill掉telescope，只保留uniagent的心跳功能 unknown: 心跳故障，不上报心跳数据，属于连接丢失故障默认取值: 不涉及
extension_name	否	String	参数解释: 插件名称，不传查所有插件约束限制: 当前仅支持查询telescope插件取值范围: telescope: 主机监控插件telescope 默认取值: telescope
extension_status	否	String	参数解释: 插件状态，不传查所有状态约束限制: 不涉及取值范围: none: 未安装 running: 运行中 stopped：已停止 fault: 进程故障，应该运行的插件，没运行，属于客户端故障 unknown: 心跳故障，不上报心跳数据，属于连接丢失故障默认取值: 不涉及

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
agent_status	Array of AgentStatusInfo objects	参数解释: agent插件状态列表

表5 AgentStatusInfo
参数	参数类型	描述
instance_id	String	参数解释: 机器id 取值范围: 1到64个字符的字符串，且只包含字母、数字和连字符
uniagent_status	String	参数解释: uniagent运行状态取值范围: none: 未安装 running: 运行中 silent: 静默状态，用于大规模插件异常时，紧急规避的一种措施，现象是kill掉telescope，只保留uniagent的心跳功能 unknown: 心跳故障，不上报心跳数据，属于连接丢失故障
extensions	Array of ExtensionInfo objects	参数解释: 插件信息列表

表6 ExtensionInfo
参数	参数类型	描述
name	String	参数解释: 插件名称取值范围: 长度为[1,64]个字符
status	String	参数解释: 插件状态取值范围: none: 未安装 running: 运行中 stopped: 已停止 fault: 故障（进程异常） unknown: 故障（连接异常）
version	String	参数解释: 插件版本取值范围: 长度为[1,32]个字符

状态码：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	错误信息

请求示例

{
  "instance_ids" : [ "111111111111" ],
  "uniagent_status" : "none",
  "extension_name" : "telescope",
  "extension_status" : "none"
}

响应示例

状态码：200

插件状态查询返回体

{
  "agent_status" : [ {
    "instance_id" : "111111111111",
    "uniagent_status" : "none",
    "extensions" : [ {
      "name" : "telescope",
      "status" : "none",
      "version" : "2.5.6"
    } ]
  } ]
}