DiagnoseInstance - Elasticsearch - Alibaba Cloud ドキュメントセンター

Elasticsearch クラスターを診断します。

デバッグ

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

リクエストヘッダー

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

リクエスト構文

POST /openapi/diagnosis/instances/{InstanceId}/actions/diagnose HTTP/1.1

リクエストパラメーター

要素	タイプ	場所	必須	例	説明
InstanceId	String	Path	はい	es-cn-n6w1o1x0w001c****	インスタンス ID。
lang	String	Query	いいえ	en	レポートの言語を取得します。デフォルトはブラウザの言語で、以下をサポートしています。 en: 英語 zh: 簡体字中国語 zt: 繁体字中国語 es: スペイン語 FR: フランス語
ClientToken	String	Query	いいえ	5A2CFF0E-5718-45B5-9D4D-70B3FF****	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用して値を生成できますが、異なるリクエスト間で値が一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。
	Object	Body	いいえ		診断タスクに関する情報。
indices	String の配列	Body	いいえ	["library"]	診断インデックスのリスト。 type パラメーターが ALL に設定されている場合、indices パラメーターを null に設定できます。
diagnoseItems	String の配列	Body	いいえ	["ClusterBulkRejectDiagnostic",...]	診断項目。詳細については、「ListDiagnosisItems」の戻り値の結果をご参照ください。
type	String	Body	いいえ	ALL	診断タスクのタイプ。有効な値： ALL: すべてのインデックスが診断されます。 SELECT: 選択したインデックスを診断します。

レスポンスパラメーター

要素	タイプ	例	説明
RequestId	String	5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***	リクエスト ID。
Result	Object		返されたデータ。
createTime	Long	1535745731000	診断レポートが生成されたタイムスタンプ。
reportId	String	trigger__2020-08-17T17:09:02	レポート ID。
state	String	RUNNING	診断ステータス。有効な値：サポートされているのは、SUCCESS、FAILED、RUNNING です。
instanceId	String	es-cn-n6w1o1x0w001c****	診断インスタンスの ID。

例

リクエストの例

POST /openapi/diagnosis/instances/es-cn-n6w1o1x0w001c****/actions/diagnose?lang=en&ClientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF**** HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

 {
    "indices":[],
    "type":"ALL",
    "diagnoseItems":[
        "ClusterBulkRejectDiagnostic",
        "IndexAliasUseDiagnostic",
        "ClusterColorStatusDiagnostic",
        "ClusterDiskResourceDiagnostic",
        "IndexRecoverySlowDiagnostic",
        "IndexReplicaDiagnostic",
        "KibanaIndexToMuchDiagnostic",
        "MasterNodeHighLoadDiagnostic",
        "NodeLeftDiagnostic",
        "NodeLoadDeviationDiagnostic",
        "ClusterComputingResourceDiagnostic",
        "NodeShardsToMuchDiagnostic",
        "IndexRegexpDeleteDiagnostic",
        "IndexSegmentsDiagnostic",
        "IndexShardsDiagnostic",
        "ClusterMinMasterDiagnostic",
        "ClusterStateVersionDiagnostic",
        "ErrorLogDiagnostic",
        "FullGcLogDiagnostic",
        "AutoSnapshotOpenDiagnostic"
    ]
}

成功レスポンスの例

JSON 形式

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

{
  "Result" : {
    "reportId" : "trigger__2020-10-19T16:49:56",
    "instanceId" : "es-cn-n6w1o1x0w001c****",
    "state" : "RUNNING",
    "createTime" : 0,
    "diagnoseItems" : [ ]
  },
  "RequestId" : "1EE5BB1E-7ECE-4CFE-A05A-7F1EE2C4****"
}

エラーコード

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