ListNodes - 查询搜索采集器下机器状态-检索分析服务 Elasticsearch版(ES)-阿里云帮助中心

智能运维的历史报告列表。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

elasticsearch:ListNodes

none

*collectors

acs:elasticsearch:{#regionId}:{#accountId}:collectors/{#collectorsId}

无

请求语法

GET /openapi/collectors/{ResId}/nodes HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
ResId	string	是	采集器 ID。	ct-cn-l871nd0u73c45****

请求参数

名称	类型	必填	描述	示例值
page	integer	否	返回结果的分页数。	1
size	integer	否	每页的结果数。	10
ecsInstanceIds	string	否	ECS 实例 ID 列表。	i-bp1ei8ysh7orb6eq****
ecsInstanceName	string	否	ECS 实例名称。	test
tags	string	否	ECS 实例的标签信息。必须包含标签键（tagKey）和标签值（tagValue）。	[{"tagKey":"abc","tagValue":"xyz"}]

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	E1FD7642-7C40-4FF2-9C0F-21F1A1746F70
Headers	object	返回头信息。
X-Total-Count	integer	返回记录数。	10
Result	array<object>	返回结果。
	array<object>
ecsInstanceId	string	ECS 实例 ID。	i-bp13y63575oypr****
cloudAssistantStatus	string	是否已开通云助手。支持： true：开通 false：未开通	true
ecsInstanceName	string	ECS 实例名称。	ECS_beat
osType	string	ECS 实例的操作系统类型。支持： windows：Windows Server linux：Linux	linux
ipAddress	array<object>	ECS 实例的 IP 信息列表。
	object
host	string	IP 地址。	192.168.xx.xx
ipType	string	IP 地址类型。支持： public：公网 IP 地址 private：私网 IP 地址	public
agentStatus	string	ECS 上各采集器的状态。支持： heartOk：心跳正常 heartLost：心跳异常 uninstalled：未安装 failed：安装失败	heartOk
status	string	ECS 实例状态。支持： running：运行中 starting：启动中 stopping：停止中 stopped：已停止	running
tags	array<object>	ECS 实例的标签信息。
	object
tagValue	string	标签值。	xyz
tagKey	string	标签键。	abc

示例

正常返回示例

JSON格式

{
  "RequestId": "E1FD7642-7C40-4FF2-9C0F-21F1A1746F70",
  "Headers": {
    "X-Total-Count": 10
  },
  "Result": [
    {
      "ecsInstanceId": "i-bp13y63575oypr****",
      "cloudAssistantStatus": "true",
      "ecsInstanceName": "ECS_beat",
      "osType": "linux",
      "ipAddress": [
        {
          "host": "192.168.xx.xx",
          "ipType": "public"
        }
      ],
      "agentStatus": "heartOk",
      "status": "running",
      "tags": [
        {
          "tagValue": "xyz",
          "tagKey": "abc"
        }
      ]
    }
  ]
}

错误码

HTTP status code	错误码	错误信息
400	ComponentCodeValueError	component value is disable
401	UserNotOpen	Aliyun account is not open elasticsearch
401	StsRoleAccountNoPermission	Role account has no permission or expired
401	SubAccountNoPermission	Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM
401	UserUnauthorized	Authentication required

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

变更历史

更多信息，参考变更详情。