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

Elasticsearch:DescribeElasticsearchHealth

最終更新日:Mar 17, 2025

指定された Elasticsearch クラスターのヘルスステータスを照会します。

Elasticsearch クラスターは、次のいずれかの色で示されるヘルス状態になります。

  • GREEN:プライマリシャードとプライマリシャードのレプリカシャードは正常に割り当てられています。
  • YELLOW:プライマリシャードは正常に割り当てられていますが、セカンダリシャードは正常に割り当てられていません。
  • RED:プライマリシャードは正常に割り当てられていません。

デバッグ

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

リクエストヘッダー

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

リクエスト構文

GET /openapi/instances/{InstanceId}/elasticsearch-health HTTP/1.1

リクエストパラメーター

パラメーター タイプ 位置 必須 説明
InstanceId String Path Yes es-cn-tl325wxga000l****

リクエスト ID。

レスポンスパラメーター

パラメーター タイプ 説明
Code String 200

レスポンスコード。

Message String success

レスポンスメッセージ。

RequestId String 0731F217-2C8A-4D42-8BCD-5C352866E3B7

リクエスト ID。

Result String GREEN

クラスターのヘルスステータスを示す色。

リクエストの例

GET /openapi/instances/[es-cn-tl325wxga000l****]/elasticsearch-health HTTP/1.1
共通リクエストヘッダー

正常なレスポンスの例

JSON 形式

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

{
  "Result" : "GREEN",
  "RequestId" : "0731F217-2C8A-4D42-8BCD-5C352866E3B7"
}

HTTP ステータスコード

エラーコードのリストについては、「サービスエラーコード」をご参照ください。