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

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeMonitoringAgentStatuses

要执行的操作,取值:DescribeMonitoringAgentStatuses

InstanceIds String i-hp3dunahluwajv6f****

实例ID。多个实例ID之间用半角逗号(,)分隔。

HostAvailabilityTaskId String 126****

可用性监控的任务ID。

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

返回数据

名称 类型 示例值 描述
Code String 200

状态码。

说明 200表示成功。
Message String The specified resource is not found.

错误信息。

RequestId String 6F8371DF-AB81-41B8-9E1B-5493B3FF0E4F

请求ID。

Success Boolean true

操作是否成功。取值:

  • true:成功。
  • false:失败。
NodeStatusList Array of NodeStatus

状态列表。

NodeStatus
Status String running

插件的运行状态。取值:

  • running:运行中。
  • stopped:已停止。
  • installing:安装中。
  • install_faild:安装失败。
  • abnormal:安装异常。
  • not_installed:未安装。
InstanceId String i-hp3dunahluwajv6f****

实例ID。

AutoInstall Boolean true

是否开启自动安装插件。取值:

  • true:开启自动安装插件。
  • false:关闭自动安装插件。
OsMonitorStatus String running

SysOM的开启状态。取值:

  • installing:开启中。
  • running:运行中。
  • stopped:已停止。
  • uninstalling:关闭中。
OsMonitorErrorCode String install_fail

SysOM的错误状态。取值:

  • install_fail:开启错误或未知错误。
  • install_assist_invalid:云助手状态引起的开启错误。
  • install_assist_command_fail:执行开启命令失败,导致的开启错误。
  • uninstall_fail:关闭错误或未知错误。
  • uninstall_assist_invalid:云助手状态引起的关闭错误。
  • uninstall_assist_command_fail:执行关闭命令失败,导致的开启错误。
OsMonitorErrorDetail String Command.ErrorCode.Fail.Downlaod.REGIN_ID

执行错误的详细信息。取值:

  • 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服务启动失败(未知原因)。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeMonitoringAgentStatuses
&InstanceIds=i-hp3dunahluwajv6f****
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeMonitoringAgentStatusesResponse>
	<RequestId>6F8371DF-AB81-41B8-9E1B-5493B3FF0E4F</RequestId>
	<NodeStatusList>
		<NodeStatus>
			<Status>running</Status>
			<AutoInstall>true</AutoInstall>
			<InstanceId>i-hp3dunahluwajv6f****</InstanceId>
		</NodeStatus>
	</NodeStatusList>
	<Code>200</Code>
	<Success>true</Success>
</DescribeMonitoringAgentStatusesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "6F8371DF-AB81-41B8-9E1B-5493B3FF0E4F",
  "NodeStatusList" : {
    "NodeStatus" : [ {
      "Status" : "running",
      "AutoInstall" : true,
      "InstanceId" : "i-hp3dunahluwajv6f****"
    } ]
  },
  "Code" : 200,
  "Success" : true
}

错误码

HttpCode 错误码 错误信息 描述
404 ResourceNotFound The specified resource is not found. 未找到指定资源。

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