DescribeDiagnoseReport - 检索分析服务Elasticsearch版

调试

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

请求头

该接口使用公共请求头，无特殊请求头。请参见公共请求参数文档。

请求语法

GET /openapi/diagnosis/instances/[InstanceId]/reports/[ReportId] HTTP/1.1

请求参数


名称	类型	位置	是否必选	示例值	描述
InstanceId	String	Path	是	es-cn-mp91kzb8m0009****	实例ID。
ReportId	String	Path	是	scheduled__2020-09-15T00:40:00	报告ID。可通过ListDiagnoseReportIds API获取。
lang	String	Query	否	en	生成智能诊断报告的语言，支持多种语言，默认为en。

返回数据


名称	类型	示例值	描述
RequestId	String	5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****	请求ID。
Result	Struct		返回结果。
createTime	Long	1535745731000	报告创建的时间戳。
diagnoseItems	Array of diagnoseItems		报告诊断项信息列表。
detail	Struct		诊断项详情。
desc	String	Check whether the number of replica shards is optimal and easy to maintain	诊断项说明。
name	String	Number of Replica Shards	诊断项全称。
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....	诊断建议。
type	String	ES_API	诊断结果类型。支持：TEXT（文本描述）、CONSOLE_API（控制台触发型）、ES_API（API触发型）。
health	String	YELLOW	诊断项的健康度。支持：GREEN、YELLOW、RED和UNKNOWN。
item	String	IndexAliasUseDiagnostic	诊断项名称。
health	String	YELLOW	报告中集群整体的健康度。支持：GREEN、YELLOW、RED和UNKNOWN。
instanceId	String	es-cn-abc	诊断的实例ID。
reportId	String	trigger__2020-08-17T17:09:02	报告ID。
state	String	SUCCESS	诊断状态。支持：SUCCESS、FAILED和RUNNING。
trigger	String	SYSTEM	健康诊断的触发方式。支持：SYSTEM（系统自动触发）、INNER（内部触发）和USER（用户手动触发）。

示例

请求示例

GET /openapi/diagnosis/instances/es-cn-09k1rocex0006****/reports/scheduled__2020-09-15T00:40:00?lang=en HTTP/1.1
公共请求头

正常返回示例

JSON格式

{
	"Result": {
		"reportId": "scheduled__2020-09-15T02:40:00",
		"instanceId": "es-cn-09k1rocex0006****",
		"state": "SUCCESS",
		"trigger": "INNER",
		"health": "YELLOW",
		"createTime": 1600108800000,
		"diagnoseItems": [
			{
				"item": "IndexReplicaDiagnostic",
				"health": "YELLOW",
				"detail": {
					"name": "Number of Replica Shards",
					"desc": "Check whether the number of replica shards is optimal and easy to maintain.\nReplica shards can increase the index data reliability and improve the QPS if the resources are sufficient. However, too many replica shards may consume large amounts of disk space and memory. This reduces the performance of write operations.",
					"type": "CONSOLE_API",
					"suggest": "You can call the following function in the Elasticsearch API: \nPUT ${index}/_settings\n{\n    \"settings\": {\n        \"index.number_of_replicas\": \"${num}\"\n    }\n} \r\nSet the index and num parameters to the actual values.",
					"result": "You may need to adjust the numbers of replica shards of some indices as follows: \n[geoname08 : 0 -> 1][geoname09 : 0 -> 1][geonametest01 : 0 -> 1]"
				}
			},
			{
				"item": "IndexShardsDiagnostic",
				"health": "YELLOW",
				"detail": {
					"name": "Number and Sizes of Shards in Each Index",
					"desc": "Check whether the number and sizes of shards in each index are optimal.\nA small number of shards may degrade the read and write performance of an index. A large number of shards consume a lot of system resources and degrade the read and write performance of an index.",
					"type": "ES_API",
					"suggest": "We recommend the following solution: \nhotmovies [size < 1 GB] [7 -> 1, 3]\ngeoname08 [2 GB] [5 -> 1, 3]\ngeoname09 [3 GB] [5 -> 1, 3]\ngeonametest01 [2 GB] [5 -> 1, 3]\n \r\nThis solution applies to the current index sizes. Adjust the number of shards based on the future indices and nodes.",
					"result": "You may need to adjust the number of shards in some indices."
				}
			}
		]
	},
	"RequestId": "7BABD728-1584-432C-A300-25BEBDFC****"
}

错误码

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