文档首页> 云监控服务 CES> API参考> API V3> 插件状态查询> 插件状态查询
更新时间：2024-04-26 GMT+08:00
在线调试
CLI示例
查看PDF
分享

插件状态查询

功能介绍

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

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目id

最小长度：1

最大长度：64

正则匹配：^[a-z0-9]+$

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

发送的实体的MIME类型。默认使用application/json; charset=UTF-8。

缺省值：application/json; charset=UTF-8

最小长度：1

最大长度：64

X-Auth-Token

是

String

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

最小长度：1

最大长度：16384
表3 请求Body参数

参数

是否必选

参数类型

描述

instance_ids

是

Array of strings

机器实例id列表

数组长度：1 - 2000

uniagent_status

否

String

uniagent运行状态，不传查所有状态,none无，running运行中，silent静默中，unknown故障

枚举值：

  • none

  • running

  • silent

  • unknown

extension_name

否

String

插件名称，不传查所有插件，目前仅支持telescope

枚举值：

  • telescope

extension_status

否

String

插件状态，不传查所有状态, none未安装，running运行中，stopped已停止，fault故障（进程异常），unknown故障（连接异常）

枚举值：

  • none

  • running

  • stopped

  • fault

  • unknown

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

agent_status

Array of AgentStatusInfo objects

agent插件状态列表

数组长度：1 - 2000
表5 AgentStatusInfo

参数

参数类型

描述

instance_id

String

机器id

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

uniagent_status

String

uniagent运行状态,none无，running运行中，silent静默中，unknown故障

枚举值：

  • none

  • running

  • silent

  • unknown

extensions

Array of ExtensionInfo objects

插件信息列表

数组长度：1 - 10
表6 ExtensionInfo

参数

参数类型

描述

name

String

插件名称

最小长度：1

最大长度：64

status

String

插件状态, none未安装，running运行中，stopped已停止，fault故障（进程异常），unknown故障（连接异常）

枚举值：

  • none

  • running

  • stopped

  • fault

  • unknown

version

String

插件版本

最小长度：1

最大长度：32

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

正则匹配：^(ces\.[0-9]{4})$

error_msg

String

错误信息

最小长度：1

最大长度：256

状态码： 401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

正则匹配：^(ces\.[0-9]{4})$

error_msg

String

错误信息

最小长度：1

最大长度：256

状态码： 403

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

正则匹配：^(ces\.[0-9]{4})$

error_msg

String

错误信息

最小长度：1

最大长度：256

状态码： 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

正则匹配：^(ces\.[0-9]{4})$

error_msg

String

错误信息

最小长度：1

最大长度：256

请求示例

{
  "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"
    } ]
  } ]
}

状态码

状态码

描述

200

插件状态查询返回体

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

错误码

请参见错误码。

父主题： 插件状态查询
分享：

    相关文档

    相关产品