すべてのプロダクト
Search
ドキュメントセンター

Elasticsearch:ListNodes

最終更新日:Mar 17, 2025

ListNodes を呼び出して、コレクターがインストールされている ECS マシンのステータスを表示します。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。操作を呼び出すと、OpenAPI Explorer はさまざまな SDK の操作のサンプルコードを動的に生成します。

リクエストヘッダー

この操作では、共通リクエストヘッダーのみを使用します。詳細については、「共通リクエストパラメーター」をご参照ください。

リクエスト構造


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

リクエストパラメーター

パラメーター タイプ 位置 必須 説明
ResId 文字列 パス はい ct-cn-l871nd0u73c45****

コレクター ID。

page 整数 クエリ いいえ 1

返される結果のページ数。

size 整数 クエリ いいえ 10

1 ページあたりの結果数。

ecsInstanceIds 文字列 クエリ いいえ i-bp1ei8ysh7orb6eq****

ECS インスタンス N の ID。

ecsInstanceName 文字列 クエリ いいえ test

ECS インスタンス名。

tags 文字列 クエリ いいえ [{"tagKey":"abc","tagValue":"xyz"}]

ECS インスタンスのタグ情報。タグキー (tagKey) とタグ値 (tagValue) を含める必要があります。

レスポンスパラメーター

パラメーター タイプ 説明
Headers 構造体

レスポンスのヘッダー。

X-Total-Count 整数 10

返されたエントリの数。

RequestId 文字列 E1FD7642-7C40-4FF2-9C0F-21F1A1746F70

リクエストの ID。

Result Result の配列

戻り値。

agentStatus 文字列 heartOk

ECS 上の各コレクターのステータス。その後、次の操作を実行できます。

  • heartOk: 通常のハートビート
  • heartLost: 異常なハートビート
  • uninstalled: インストールされていない
  • failed: インストール失敗
cloudAssistantStatus 文字列 true

クラウドアシスタントが開かれているかどうか。その後、次の操作を実行できます。

  • true: 開く
  • false: 有効になっていない
ecsInstanceId 文字列 i-bp13y63575oypr****

インスタンスの ID。

ecsInstanceName 文字列 ECS_beat

ECS インスタンス名。

ipAddress ipAddress の配列

ECS インスタンスの IP 情報リスト。

host 文字列 192.168.xx.xx

IP アドレス。

ipType 文字列 public

IP アドレスのタイプ。その後、次の操作を実行できます。

  • public: パブリック IP アドレス
  • private: プライベート IP アドレス
osType 文字列 linux

ECS インスタンスのオペレーティングシステムタイプ。その後、次の操作を実行できます。

  • windows: Windows Server
  • linux: Linux
status 文字列 running

ECS インスタンスのステータス。その後、次の操作を実行できます。

  • running: クラスタが実行されています。
  • starting
  • stopping: 停止中
  • stopped: ノードが停止しています。
tags tags の配列

ECS インスタンスのタグ情報。

tagKey 文字列 abc

タグのキー。

tagValue 文字列 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 } } 
   

エラーコード

エラーコードの一覧については、 API エラーセンター をご覧ください。