调用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****"
}

错误码

访问错误中心查看更多错误码。