# 查询指定诊断报告 - ShowDiagnosisTaskDetails #### 功能介绍 通过报告ID查询诊断报告的详细信息。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dcs/api-call-process.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dcs/api-grant-policy.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | dcs:instance:getDiagnosisTask | Read | instance \* | - g:EnterpriseProjectId - g:ResourceTag/\ | dcs:instance:diagnosis | - | #### URI GET /v2/{project_id}/diagnosis/{report_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-dcs/dcs-api-0312045.html)。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | report_id | 是 | String | **参数解释**： 诊断报告ID。 **约束限制**： 必须为存在且非"诊断中"或"已删除"状态的报告ID。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表2响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | abnormal_item_sum | Integer | **参数解释**： 异常诊断项总数。 **取值范围**： 大于等于0的整数。 | | failed_item_sum | Integer | **参数解释**： 失败诊断项总数（不含故障节点级失败）。 **取值范围**： 大于等于0的整数。 | | diagnosis_node_report_list | Array of [DiagnosisNodeReport] objects | **参数解释**： 节点诊断报告列表。 **取值范围**： 不涉及。 | 表3DiagnosisNodeReport | 参数 | 参数类型 | 描述 | |:---|:---|:---| | group_name | String | **参数解释**： 节点所在分片的名称。 **取值范围**： 不涉及。 | | az_code | String | **参数解释**： 节点所在可用区Code。 **取值范围**： 不涉及。 | | node_ip | String | **参数解释**： 节点IP地址。 **取值范围**： 不涉及。 | | abnormal_sum | Integer | **参数解释**： 诊断结果为异常的诊断项总数。 **取值范围**： 大于等于0的整数。 | | failed_sum | Integer | **参数解释**： 诊断失败的诊断项总数。 **取值范围**： 大于等于0的整数。 | | role | String | **参数解释**： 节点角色。 **取值范围**： - master：主节点 - slave：备节点 | | diagnosis_dimension_list | Array of [DiagnosisDimension] objects | **参数解释**： 诊断维度列表。 **取值范围**： 不涉及。 | | command_time_taken_list | [CommandTimeTakenList] object | **参数解释**： 命令耗时统计列表。 **取值范围**： 不涉及。 | 表4DiagnosisDimension | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**： 诊断维度名称。 **取值范围**： 不涉及。 | | abnormal_num | Integer | **参数解释**： 诊断结果为异常的诊断项总数。 **取值范围**： 大于等于0的整数。 | | failed_num | Integer | **参数解释**： 诊断失败的诊断项总数。 **取值范围**： 大于等于0的整数。 | | diagnosis_item_list | Array of [DiagnosisItem] objects | **参数解释**： 诊断项列表。 **取值范围**： 不涉及。 | 表5DiagnosisItem | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**： 诊断项名称。 **取值范围**： 不涉及。 | | cause_ids | Array of [ConclusionItem] objects | **参数解释**： 原因ID列表，ID说明请见[实例诊断ID说明](https://support.huaweicloud.com/api-dcs/dcs-api-0312050.html)。 **取值范围**： 不涉及。 | | impact_ids | Array of [ConclusionItem] objects | **参数解释**： 影响ID列表，ID说明请见[实例诊断ID说明](https://support.huaweicloud.com/api-dcs/dcs-api-0312050.html)。 **取值范围**： 不涉及。 | | advice_ids | Array of [ConclusionItem] objects | **参数解释**： 建议ID列表，ID说明请见[实例诊断ID说明](https://support.huaweicloud.com/api-dcs/dcs-api-0312050.html)。 **取值范围**： 不涉及。 | | result | String | **参数解释**： 诊断结果。 **取值范围**： 不涉及。 | | error_code | String | **参数解释**： 错误码。 **取值范围**： 请参见[错误码](https://support.huaweicloud.com/api-dcs/ErrorCode.html)。 | 表6ConclusionItem | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | Integer | **参数解释**： 结论ID。 **取值范围**： 不涉及。 | | params | Map\ | **参数解释**： 结论参数。 **取值范围**： 不涉及。 | 表7CommandTimeTakenList | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_num | Integer | **参数解释**： 执行命令的总次数。 **取值范围**： 大于等于0的整数。 | | total_usec_sum | Double | **参数解释**： 执行命令总耗时，单位微秒。 **取值范围**： 大于等于0的浮点数。 | | result | String | **参数解释**： 命令耗时统计结果。 **取值范围**： 不涉及。 | | command_list | Array of [CommandTimeTaken] objects | **参数解释**： 命令耗时统计列表。 **取值范围**： 不涉及。 | | error_code | String | **参数解释**： 错误码。 **取值范围**： 请参见[错误码](https://support.huaweicloud.com/api-dcs/ErrorCode.html)。 | 表8CommandTimeTaken | 参数 | 参数类型 | 描述 | |:---|:---|:---| | calls_sum | Long | **参数解释**： 命令调用总次数。 **取值范围**： 大于等于0的长整数。 | | usec_sum | Double | **参数解释**： 命令总耗时，单位微秒。 **取值范围**： 大于等于0的浮点数。 | | command_name | String | **参数解释**： 命令名称。 **取值范围**： 不涉及。 | | per_usec | String | **参数解释**： 耗时占比。 **取值范围**： 不涉及。 | | average_usec | Double | **参数解释**： 每次调用平均耗时，单位微秒。 **取值范围**： 大于等于0的浮点数。 | **状态码：400** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_msg | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。 | | error_code | String | **参数解释**： 错误码。 **取值范围**： 请参见[错误码](https://support.huaweicloud.com/api-dcs/ErrorCode.html)。 | | error_ext_msg | String | **参数解释**： 扩展错误信息（暂未使用，赋值为null）。 **取值范围**： 不涉及。 | **状态码：500** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_msg | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。 | | error_code | String | **参数解释**： 错误码。 **取值范围**： 请参见[错误码](https://support.huaweicloud.com/api-dcs/ErrorCode.html)。 | | error_ext_msg | String | **参数解释**： 扩展错误信息（暂未使用，赋值为null）。 **取值范围**： 不涉及。 | #### 请求示例 ``` GET https://{dcs_endpoint}/v2/{project_id}/diagnosis/{report_id} ``` #### 响应示例 **状态码：200** ``` { "abnormal_item_sum" : 1, "failed_item_sum" : 0, "diagnosis_node_report_list" : [ { "group_name" : "group-0", "az_code" : "region01", "node_ip" : "192.168.0.170:6379", "abnormal_sum" : 1, "failed_sum" : 0, "role" : "master", "command_time_taken_list" : { "command_list" : [ { "calls_sum" : 329, "usec_sum" : 20.732, "command_name" : "info", "per_usec" : "68.61%", "average_usec" : 0.063 }, { "calls_sum" : 1788, "usec_sum" : 1.787, "command_name" : "ping", "per_usec" : "5.91%", "average_usec" : 0.001 }, { "calls_sum" : 2, "usec_sum" : 0.025, "command_name" : "config", "per_usec" : "0.08%", "average_usec" : 0.013 }, { "calls_sum" : 60, "usec_sum" : 0.186, "command_name" : "slowlog", "per_usec" : "0.62%", "average_usec" : 0.003 }, { "calls_sum" : 1764, "usec_sum" : 7.485, "command_name" : "publish", "per_usec" : "24.77%", "average_usec" : 0.004 } ], "result" : "succeed", "error_code" : null, "total_num" : 5, "total_usec_sum" : 30.215 }, "diagnosis_dimension_list" : [ { "name" : "load", "abnormal_num" : 0, "failed_num" : 0, "diagnosis_item_list" : [ { "name" : "cpu_usage", "result" : "normal", "cause_ids" : null, "impact_ids" : null, "advice_ids" : null, "error_code" : null }, { "name" : "time_consuming_commands", "result" : "normal", "cause_ids" : null, "impact_ids" : null, "advice_ids" : null, "error_code" : null } ] }, { "name" : "storage", "abnormal_num" : 1, "failed_num" : 0, "diagnosis_item_list" : [ { "name" : "inner_memory_fragmentation", "result" : "normal", "cause_ids" : [ { "id" : 7, "params" : null } ], "impact_ids" : [ { "id" : 3, "params" : null } ], "advice_ids" : [ { "id" : 4, "params" : null } ], "error_code" : null }, { "name" : "persistence", "result" : "normal", "cause_ids" : null, "impact_ids" : null, "advice_ids" : null, "error_code" : null }, { "name" : "centralized_expiration", "result" : "normal", "cause_ids" : null, "impact_ids" : null, "advice_ids" : null, "error_code" : null }, { "name" : "memory_usage", "result" : "normal", "cause_ids" : null, "impact_ids" : null, "advice_ids" : null, "error_code" : null }, { "name" : "hit_ratio", "result" : "normal", "cause_ids" : null, "impact_ids" : null, "advice_ids" : null, "error_code" : null } ] }, { "name" : "network", "abnormal_num" : 0, "failed_num" : 0, "diagnosis_item_list" : [ { "name" : "connection_num", "result" : "normal", "cause_ids" : null, "impact_ids" : null, "advice_ids" : null, "error_code" : null }, { "name" : "rx_controlled", "result" : "normal", "cause_ids" : null, "impact_ids" : null, "advice_ids" : null, "error_code" : null } ] } ] } ] } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.dcs.v2.region.DcsRegion; import com.huaweicloud.sdk.dcs.v2.*; import com.huaweicloud.sdk.dcs.v2.model.*; public class ShowDiagnosisTaskDetailsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); DcsClient client = DcsClient.newBuilder() .withCredential(auth) .withRegion(DcsRegion.valueOf("")) .build(); ShowDiagnosisTaskDetailsRequest request = new ShowDiagnosisTaskDetailsRequest(); request.withReportId("{report_id}"); try { ShowDiagnosisTaskDetailsResponse response = client.showDiagnosisTaskDetails(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - [Python] ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdcs.v2.region.dcs_region import DcsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdcs.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = DcsClient.new_builder() \ .with_credentials(credentials) \ .with_region(DcsRegion.value_of("")) \ .build() try: request = ShowDiagnosisTaskDetailsRequest() request.report_id = "{report_id}" response = client.show_diagnosis_task_details(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dcs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := dcs.DcsClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dcs.NewDcsClient(hcClient) request := &model.ShowDiagnosisTaskDetailsRequest{} request.ReportId = "{report_id}" response, err := client.ShowDiagnosisTaskDetails(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DCS/sdk?api=ShowDiagnosisTaskDetails&version=v2)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询指定报告成功。 | | 400 | 非法请求。 | | 500 | 内部服务错误。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dcs/ErrorCode.html)。