調用DiagnoseInstance，即刻診斷實例。

調試

您可以在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****"
}

錯誤碼

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