DiagnoseInstance - Elasticsearch

調試

您可以在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****	用於保證請求的等冪性。由用戶端產生該參數值，要保證在不同請求間唯一，最大不超過64個ASCII字元。
	Object	Body	否		診斷任務資訊。
indices	Array of String	Body	否	["library"]	診斷索引列表。type為ALL時，indices可設定為空白。
diagnoseItems	Array of 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****"
}

錯誤碼

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