Elasticsearch クラスターの履歴インテリジェント O&M レポートをクエリします。
デバッグ
リクエストヘッダー
この操作には操作固有のリクエストヘッダーはなく、共通のリクエストヘッダーのみを使用します。 詳細については、「共通パラメーター」トピックの「共通リクエストパラメーター」セクションをご参照ください。
リクエスト構文
GET /openapi/diagnosis/instances/{InstanceId}/reports HTTP/1.1
リクエストパラメーター
|
パラメーター |
タイプ |
位置 |
必須 |
例 |
説明 |
| InstanceId | String | Path | Yes | es-cn-n6w1qu7ei000p**** | インスタンス ID。 |
| lang | String | Query | No | es | レポートの言語。 デフォルトはブラウザの言語で、以下をサポートしています。
|
| startTime | Long | Query | Yes | 1594569600000 | クエリ対象期間の開始時刻。 値は UNIX タイムスタンプである必要があります。 単位:ミリ秒。
|
| endTime | Long | Query | Yes | 1595174399999 | クエリ対象期間の終了時刻。 値は UNIX タイムスタンプである必要があります。 単位:ミリ秒。
|
| page | Integer | Query | No | 1 | 返すページ番号。 有効値: 1 ~ 200。 デフォルト値: 1。 |
| size | Integer | Query | No | 20 | 1 ページあたりのレポート数。 有効値: 1 ~ 500。 デフォルト値: 10。 |
| detail | Boolean | Query | No | true | 診断項目の詳細を表示するかどうか。 |
| trigger | String | Query | No | SYSTEM | ヘルス診断のトリガーモード。 以下のメソッドを使用できます。
|
レスポンスパラメーター
パラメーター |
タイプ |
例 |
説明 |
| RequestId | String | 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1**** | リクエスト ID。 |
| Headers | Object | レスポンスのヘッダー。 |
|
| X-Total-Count | Integer | 15 | 返されたエントリの総数。 |
| Result | Result の配列 | 返されたデータ。 |
|
| trigger | String | USER | ヘルス診断のトリガーモード。 有効値:
|
| createTime | Long | 1535745731000 | レポートが作成されたタイムスタンプ。 |
| reportId | String | trigger__2020-08-17T17:09:02f | レポートの ID。 |
| state | String | SUCCESS | 診断ステータス。 有効値: サポートされているのは、SUCCESS、FAILED、RUNNING です。 |
| instanceId | String | es-cn-abc | 診断インスタンスの ID。 |
| health | String | YELLOW | レポート内のクラスターの全体的なヘルス状態。 サポートされているのは、GREEN、YELLOW、RED、UNKNOWN です。 |
| diagnoseItems | diagnoseItems の配列 | 診断項目情報のリストを報告します。 |
|
| item | String | IndexAliasUseDiagnostic | 診断項目の名前。 |
| health | String | YELLOW | 診断項目のヘルスレベル。 サポートされているのは、GREEN、YELLOW、RED、UNKNOWN です。 |
| detail | Object | 診断項目の詳細。 |
|
| type | String | ES_API | 診断結果のタイプ。 有効値:
|
| name | String | Number of Replica Shards | 診断項目の正式名称。 |
| desc | String | Check whether the number of replica shards is optimal and easy to maintain | 診断項目の説明。 |
| result | String | You may need to adjust the numbers of replica shards of some indices as follows: [geoname08 : 0 -> 1][geoname09 : 0 -> 1][geonametest01 : 0 -> 1] | 診断。 |
| suggest | String | You can call the following function in the Elasticsearch API.... | 診断の提案。 |
例
サンプルリクエスト
GET /openapi/diagnosis/instances/es-cn-n6w1qu7ei000p****/reports?lang=es&startTime=1594569600000&endTime=1595174399999&page=1&size=20&detail=true&trigger=SYSTEM HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json
サンプルの成功レスポンス
JSON 形式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Result" : [ {
"reportId" : "scheduled__2020-09-15T02:40:00",
"instanceId" : "es-cn-09k1rocex0006****",
"state" : "SUCCESS",
"trigger" : "SYSTEM",
"health" : "YELLOW",
"createTime" : 1600108800000,
"diagnoseItems" : [ {
"item" : "IndexReplicaDiagnostic",
"health" : "YELLOW",
"detail" : {
"name" : "レプリカシャードの数",
"desc" : "レプリカシャードの数が最適で、メンテナンスが容易かどうかを確認します。\nリソースが十分であれば、レプリカシャードはインデックスデータの信頼性を高め、QPS を向上させることができます。 ただし、レプリカシャードが多すぎると、大量のディスク容量とメモリが消費される可能性があります。 これにより、書き込み操作のパフォーマンスが低下します。",
"type" : "CONSOLE_API",
"suggest" : "Elasticsearch API で次の関数を呼び出すことができます。\nPUT ${index}/_settings\n{\n \"settings\": {\n \"index.number_of_replicas\": \"${num}\"\n }\n} \r\nindex パラメーターと num パラメーターを実際の値に設定します。",
"result" : "一部のインデックスのレプリカシャードの数を次のように調整する必要がある場合があります。\n[geoname08 : 0 -> 1][geoname09 : 0 -> 1][geonametest01 : 0 -> 1]"
}
}, {
"item" : "IndexShardsDiagnostic",
"health" : "YELLOW",
"detail" : {
"name" : "各インデックスのシャードの数とサイズ",
"desc" : "各インデックスのシャードの数とサイズが最適かどうかを確認します。\nシャードの数が少ないと、インデックスの読み取りおよび書き込みパフォーマンスが低下する可能性があります。 シャードの数が多いと、多くのシステムリソースが消費され、インデックスの読み取りおよび書き込みパフォーマンスが低下します。",
"type" : "ES_API",
"suggest" : "以下のソリューションをお勧めします。\nhotmovies [サイズ < 1 GB] [7 -> 1, 3]\ngeoname08 [2 GB] [5 -> 1, 3]\ngeoname09 [3 GB] [5 -> 1, 3]\ngeonametest01 [2 GB] [5 -> 1, 3]\n \r\nこのソリューションは、現在のインデックスサイズに適用されます。 将来のインデックスとノードに基づいて、シャードの数を調整します。",
"result" : "一部のインデックスのシャードの数を調整する必要がある場合があります。"
}
}, {
"item" : "NodeLeftDiagnostic",
"health" : "GREEN",
"detail" : {
"name" : "欠落ノード",
"desc" : "クラスターに参加していないノードがあるかどうかを確認します。\nノードが欠落していると深刻な問題が発生する可能性があるため、すぐに対応する必要があります。",
"type" : "TEXT",
"result" : "すべてのノードがクラスターに参加しています。"
}
}, {
"item" : "FullGcLogDiagnostic",
"health" : "GREEN",
"detail" : {
"name" : "フル GC アクティビティ",
"desc" : "クラスターのフル GC アクティビティが正常かどうかを確認します。",
"type" : "TEXT",
"result" : "クラスターのフル GC アクティビティは正常です。"
}
}, {
"item" : "ClusterMinMasterDiagnostic",
"health" : "GREEN",
"detail" : {
"name" : "minimum_master_nodes 構成",
"desc" : "クラスターの discovery.zen.minimum_master_nodes 構成が最適かどうかを確認します。\nzen.min.master 構成が不適切な場合、クラスターの負荷が高い場合に、クラスターが不安定になったり、クラスターの split-brain が発生したりする可能性があります。 クラスターの split-brain は、ノードの欠落、クラスターのジッター、データの例外などの問題を引き起こす可能性があり、すぐに対応する必要があります。",
"type" : "TEXT",
"result" : "minMaster 構成は最適です。 candidateMasterCount は 3 に設定され、discovery.zen.minimum_master_nodes は 2 に設定されています。"
}
}, {
"item" : "ClusterStateVersionDiagnostic",
"health" : "GREEN",
"detail" : {
"name" : "クラスターステータスの頻繁な変更",
"desc" : "クラスターステータスが頻繁に変更されるかどうかを確認します。\nクラスターステータスが頻繁に変更されると、マスターノードの負荷が大幅に増加し、頻繁な GC アクティビティが発生し、インデックスデータの読み取りと書き込みがブロックされることによってクラスターのパフォーマンスが低下する可能性があります。",
"type" : "TEXT",
"result" : "クラスターステータスは最適な頻度で変更されます。"
}
}, {
"item" : "ErrorLogDiagnostic",
"health" : "GREEN",
"detail" : {
"name" : "例外ログ",
"desc" : "例外ログを確認します。",
"type" : "TEXT",
"result" : "例外ログは検出されていません。"
}
} ]
} ],
"RequestId" : "40962041-2864-4877-81C7-9657FDA3****",
"Headers" : {
"X-Total-Count" : 1
}
}
エラーコード
エラーコードの一覧については、サービスエラーコード をご参照ください。