DescribeDiagnoseReport - 查看智能运维的历史报告-检索分析服务 Elasticsearch版(ES)-阿里云帮助中心

调用DescribeDiagnoseReport，查看智能运维的历史报告。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

elasticsearch:DescribeDiagnoseReport

get

*Instance

acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}

无

请求语法

GET /openapi/diagnosis/instances/{InstanceId}/reports/{ReportId} HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。	es-cn-mp91kzb8m0009****
ReportId	string	是	报告 ID。可通过 ListDiagnoseReportIds API 获取。	scheduled__2020-09-15T00:40:00

请求参数

名称	类型	必填	描述	示例值
lang	string	否	生成智能诊断报告的语言。默认为浏览器语言，支持： en：英语 zh：简体中文 zt：繁体中文 es：西班牙语 fr：法语	en

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****
Result	object	返回结果。
trigger	string	健康诊断的触发方式。支持：SYSTEM（系统自动触发）、INNER（内部触发）和 USER（用户手动触发）。	SYSTEM
createTime	integer	报告创建的时间戳，单位：ms。	1535745731000
reportId	string	报告 ID。	trigger__2020-08-17T17:09:02
state	string	诊断状态。支持：SUCCESS、FAILED 和 RUNNING。	SUCCESS
instanceId	string	诊断的实例 ID。	es-cn-abc
health	string	报告中集群整体的健康度。支持：GREEN、YELLOW、RED 和 UNKNOWN。	YELLOW
diagnoseItems	array<object>	报告诊断项信息列表。
	array<object>
item	string	诊断项名称。	IndexAliasUseDiagnostic
health	string	诊断项的健康度。支持：GREEN、YELLOW、RED 和 UNKNOWN。	YELLOW
detail	object	诊断项详情。
type	string	诊断结果类型。支持：TEXT（文本描述）、CONSOLE_API（控制台触发型）、ES_API（API 触发型）。	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....
items	array<object>	诊断项明细列表；不要求详情时可能为空。
	array<object>	单个诊断项的执行结果。
item	string	诊断项编码。	cluster.health
name	string	诊断项名称。	集群健康
state	string	诊断项健康状态：GREEN、YELLOW 或 RED。	GREEN
desc	string	诊断结论描述。	一切正常
suggest	string	处理建议。	建议关注 GC
detail	object	诊断明细；不要求详情时为空。
diagnosisMode	string	诊断模式：RULE 或 AGENT。	RULE

示例

正常返回示例

JSON格式

{
  "RequestId": "5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****",
  "Result": {
    "trigger": "SYSTEM",
    "createTime": 1535745731000,
    "reportId": "trigger__2020-08-17T17:09:02",
    "state": "SUCCESS",
    "instanceId": "es-cn-abc",
    "health": "YELLOW",
    "diagnoseItems": [
      {
        "item": "IndexAliasUseDiagnostic",
        "health": "YELLOW",
        "detail": {
          "type": "ES_API",
          "name": "Number of Replica Shards",
          "desc": "Check whether the number of replica shards is optimal and easy to maintain",
          "result": "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": "You can call the following function in the Elasticsearch API...."
        }
      }
    ],
    "items": [
      {
        "item": "cluster.health",
        "name": "集群健康",
        "state": "GREEN",
        "desc": "一切正常",
        "suggest": "建议关注 GC",
        "detail": {
          "test": "test",
          "test2": 1
        }
      }
    ],
    "diagnosisMode": "RULE"
  }
}

错误码

HTTP status code	错误码	错误信息
400	ComponentCodeValueError	component value is disable
401	UserNotOpen	Aliyun account is not open elasticsearch
401	StsRoleAccountNoPermission	Role account has no permission or expired
401	SubAccountNoPermission	Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM
401	UserUnauthorized	Authentication required

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

变更历史

更多信息，参考变更详情。