ListNodes - Elasticsearch

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

要求標頭

該介面使用公用要求標頭，無特殊要求標頭。請參見公用請求參數文檔。

請求文法

GET /openapi/collectors/[ResId]/nodes HTTP/1.1

請求參數

名稱	類型	位置	是否必選	樣本值	描述
ResId	String	Path	是	ct-cn-l871nd0u73c45****	採集器ID。
page	Integer	Query	否	1	返回結果的分頁數。
size	Integer	Query	否	10	每頁的結果數。
ecsInstanceIds	String	Query	否	i-bp1ei8ysh7orb6eq****	ECS執行個體ID列表。
ecsInstanceName	String	Query	否	test	ECS執行個體名稱。
tags	String	Query	否	[{"tagKey":"abc","tagValue":"xyz"}]	ECS執行個體的標籤資訊。必須包含標籤鍵（tagKey）和標籤值（tagValue）。

返回資料

名稱	類型	樣本值	描述
Headers	Struct		返回頭資訊。
X-Total-Count	Integer	10	返回記錄數。
RequestId	String	E1FD7642-7C40-4FF2-9C0F-21F1A1746F70	請求ID。
Result	Array of Result		返回結果。
agentStatus	String	heartOk	ECS上各採集器的狀態。支援： heartOk：心跳正常 heartLost：心跳異常 uninstalled：未安裝 failed：安裝失敗
cloudAssistantStatus	String	true	是否已開通雲助手。支援： true：開通 false：未開通
ecsInstanceId	String	i-bp13y63575oypr****	ECS執行個體ID。
ecsInstanceName	String	ECS_beat	ECS執行個體名稱。
ipAddress	Array of ipAddress		ECS執行個體的IP資訊列表。
host	String	192.168.xx.xx	IP地址。
ipType	String	public	IP地址類型。支援： public：公網IP地址 private：私網IP地址
osType	String	linux	ECS執行個體的作業系統類型。支援： windows：Windows Server linux：Linux
status	String	running	ECS執行個體狀態。支援： running：運行中 starting：啟動中 stopping：停止中 stopped：已停止
tags	Array of tags		ECS執行個體的標籤資訊。
tagKey	String	abc	標籤鍵。
tagValue	String	xyz	標籤值。

樣本

請求樣本

GET /openapi/collectors/ct-cn-l871nd0u73c45****/nodes HTTP/1.1
公用要求標頭

正常返回樣本

JSON格式

{
  "Result": [
    {
      "ecsInstanceId": "i-bp13y63575oypr9d****",
      "ecsInstanceName": "zl-test02-keepit",
      "status": "running",
      "ipAddress": [
        {
          "host": "47.111.xx.xx",
          "ipType": "public"
        },
        {
          "host": "10.8.xx.xx",
          "ipType": "private"
        }
      ],
      "tags": [
        {
          "tagKey": "a",
          "tagValue": "b"
        }
      ],
      "agentStatus": "failed",
      "osType": "linux",
      "cloudAssistantStatus": "true"
    }
  ],
  "RequestId": "E1FD7642-7C40-4FF2-9C0F-21F1A1746F70",
  "Headers": {
    "X-Total-Count": 1
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。