调用DescribeMonitoringAgentStatuses查询云监控插件运行状态

调用DescribeMonitoringAgentStatuses接口查询云监控插件运行状态。

接口说明

本文将提供一个示例，查询实例i-hp3dunahluwajv6f****的云监控插件的运行状态。返回结果显示云监控插件的运行状态为running（运行中）。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
cms:DescribeMonitoringAgentStatuses	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
InstanceIds	string	是	实例 ID。多个实例 ID 之间用半角逗号（,）分隔。	i-hp3dunahluwajv6f****
HostAvailabilityTaskId	string	否	可用性监控的任务 ID。	126****

关于公共请求参数的详情，请参见公共参数。

返回参数

名称	类型	描述	示例值
	object	返回结果。
Code	string	状态码。说明 200 表示成功。	200
Message	string	错误信息。	The specified resource is not found.
RequestId	string	请求 ID。	6F8371DF-AB81-41B8-9E1B-5493B3FF0E4F
Success	boolean	操作是否成功。取值： true：成功。 false：失败。	true
NodeStatusList	array<object>	主机的状态列表。
	object	主机的状态列表。
Status	string	插件的运行状态。取值： running：运行中。 stopped：已停止。 installing：安装中。 install_faild：安装失败。 abnormal：安装异常。 not_installed：未安装。	running
InstanceId	string	实例 ID。	i-hp3dunahluwajv6f****
AutoInstall	boolean	是否开启自动安装插件。取值： true：开启自动安装插件。 false：关闭自动安装插件。	true
OsMonitorStatus	string	SysOM 的开启状态。取值： installing：开启中。 running：运行中。 stopped：已停止。 uninstalling：关闭中。	running
OsMonitorErrorCode	string	SysOM 的错误状态。取值： `install_fail`：开启错误或未知错误。 `install_assist_invalid`：云助手状态引起的开启错误。 `install_assist_command_fail`：执行开启命令失败，导致的开启错误。 `uninstall_fail`：关闭错误或未知错误。 `uninstall_assist_invalid`：云助手状态引起的关闭错误。 `uninstall_assist_command_fail`：执行关闭命令失败，导致的开启错误。	install_fail
OsMonitorErrorDetail	string	执行错误的详细信息。取值： `Command.ErrorCode.Fail.Downlaod.REGIN_ID`：获取地域 ID 失败。 `Command.ErrorCode.Fail.Downlaod.SYSAK`：下载 SYSAK RPM 失败。 `Command.ErrorCode.Fail.Downlaod.CMON_FILE`：下载 CMON 文件失败。 `Command.ErrorCode.Fail.Downlaod.BTF`：SYSAK 服务启动失败，BTF 文件缺失。 `Command.ErrorCode.Fail.Start.SYSAK`：SYSAK 服务启动失败（未知原因）。	Command.ErrorCode.Fail.Downlaod.REGIN_ID
OsMonitorVersion	string	SysOM 监控的插件版本。	1.3.0-12
OsMonitorConfig	string	SysOM 插件的配置信息`sysak`是否开启监控。取值： true：`sysak`开启监控。 false：`sysak`未开启监控。	{"sysak":true}
AgentInstallErrorCode	string	安装云监控插件的错误码。取值： Common.Timeout：安装超时。 Common.SLR：未授权云监控的 ServiceLinkRole。 Common.OS：不支持此操作系统。 Assist.Invalid：云助手未运行。 Assist.Invoke：启动安装程序错误。 Assist.Execute：安装程序执行错误。

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "The specified resource is not found.",
  "RequestId": "6F8371DF-AB81-41B8-9E1B-5493B3FF0E4F",
  "Success": true,
  "NodeStatusList": {
    "NodeStatus": [
      {
        "Status": "running",
        "InstanceId": "i-hp3dunahluwajv6f****",
        "AutoInstall": true,
        "OsMonitorStatus": "running",
        "OsMonitorErrorCode": "install_fail",
        "OsMonitorErrorDetail": "Command.ErrorCode.Fail.Downlaod.REGIN_ID",
        "OsMonitorVersion": "1.3.0-12",
        "OsMonitorConfig": "{\"sysak\":true}",
        "AgentInstallErrorCode": ""
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	ParameterInvalid	Illegal parameters.	-
403	AccessForbidden	User not authorized to operate on the specified resource.	-
404	ResourceNotFound	The specified resource is not found.	未找到指定资源。
500	InternalError	%s	-

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2023-11-24	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-07-19	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-05-04	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情