Help Center/ Distributed Cache Service/ API Reference/ API V2/ Instance Diagnosis/ Querying a Specified Diagnosis Report
Updated on 2026-09-02 GMT+08:00

Querying a Specified Diagnosis Report

Function

This API is used to query details about a diagnosis report based on the report ID.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    dcs:instance:getDiagnosisTask

    Read

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    dcs:instance:diagnosis

    -

URI

GET /v2/{project_id}/diagnosis/{report_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. For details, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

report_id

Yes

String

Definition

Diagnosis report ID.

Constraints

The report ID must exist and cannot be that of a report in the diagnosing or deleted state.

Range

N/A

Default Value

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

abnormal_item_sum

Integer

Definition

Total number of abnormal diagnosis items.

Range

An integer greater than or equal to 0.

failed_item_sum

Integer

Definition

Total number of failed diagnosis items (excluding failed ones on faulty nodes).

Range

An integer greater than or equal to 0.

diagnosis_node_report_list

Array of DiagnosisNodeReport objects

Definition

Node diagnosis report list.

Range

N/A

Table 3 DiagnosisNodeReport

Parameter

Type

Description

group_name

String

Definition

Name of the shard where the node is.

Range

N/A

az_code

String

Definition

Code of the AZ where the node is.

Range

N/A

node_ip

String

Definition

Node IP address.

Range

N/A

abnormal_sum

Integer

Definition

Total number of abnormal diagnosis items.

Range

An integer greater than or equal to 0.

failed_sum

Integer

Definition

Total number of failed diagnosis items.

Range

An integer greater than or equal to 0.

role

String

Definition

Node role.

Range

  • master: master node

  • slave: standby node

diagnosis_dimension_list

Array of DiagnosisDimension objects

Definition

Diagnosis dimension list.

Range

N/A

command_time_taken_list

CommandTimeTakenList object

Definition

Command execution duration list.

Range

N/A

Table 4 DiagnosisDimension

Parameter

Type

Description

name

String

Definition

Diagnosis dimension name.

Range

N/A

abnormal_num

Integer

Definition

Total number of abnormal diagnosis items.

Range

An integer greater than or equal to 0.

failed_num

Integer

Definition

Total number of failed diagnosis items.

Range

An integer greater than or equal to 0.

diagnosis_item_list

Array of DiagnosisItem objects

Definition

Diagnosis item list.

Range

N/A

Table 5 DiagnosisItem

Parameter

Type

Description

name

String

Definition

Diagnosis item name.

Range

N/A

cause_ids

Array of ConclusionItem objects

Definition

List of cause IDs. For details about the IDs, see Instance Diagnosis IDs.

Range

N/A

impact_ids

Array of ConclusionItem objects

Definition

List of impact IDs. For details about the IDs, see Instance Diagnosis IDs.

Range

N/A

advice_ids

Array of ConclusionItem objects

Definition

List of suggestion IDs. For details about the IDs, see Instance Diagnosis IDs.

Range

N/A

result

String

Definition

Diagnosis result.

Range

N/A

error_code

String

Parameter description:

Error code.

Value range:

For details, see Error Codes.

Table 6 ConclusionItem

Parameter

Type

Description

id

Integer

Definition

Conclusion ID.

Range

N/A

params

Map<String,String>

Definition

Conclusion parameters.

Range

N/A

Table 7 CommandTimeTakenList

Parameter

Type

Description

total_num

Integer

Definition

Total number of times that commands are executed.

Range

An integer greater than or equal to 0.

total_usec_sum

Double

Definition

Total command execution time, in microseconds.

Range

A floating-point number greater than or equal to 0.

result

String

Definition

Command execution duration result.

Range

N/A

command_list

Array of CommandTimeTaken objects

Definition

Command execution duration list.

Range

N/A

error_code

String

Parameter description:

Error code.

Value range:

For details, see Error Codes.

Table 8 CommandTimeTaken

Parameter

Type

Description

calls_sum

Long

Definition

Total number of command calls.

Range

A long integer greater than or equal to 0.

usec_sum

Double

Definition

Total command execution time, in microseconds.

Range

A floating-point number greater than or equal to 0.

command_name

String

Definition

Command name.

Range

N/A

per_usec

String

Definition

Duration percentage.

Range

N/A

average_usec

Double

Definition

Average time consumed for each call, in microseconds.

Range

A floating-point number greater than or equal to 0.

Status code: 400

Table 9 Response body parameters

Parameter

Type

Description

error_msg

String

Definition

Error information.

Range

N/A

error_code

String

Definition

Error code.

Range

For details, see Error Codes.

error_ext_msg

String

Definition

Extended error information. This parameter is not used currently and is set to null.

Range

N/A

Status code: 500

Table 10 Response body parameters

Parameter

Type

Description

error_msg

String

Definition

Error information.

Range

N/A

error_code

String

Definition

Error code.

Range

For details, see Error Codes.

error_ext_msg

String

Definition

Extended error information. This parameter is not used currently and is set to null.

Range

N/A

Example Requests

None

Example Responses

Status code: 200

The specified report is queried successfully.

{
  "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 Sample Code

The SDK sample code is as follows.

Java

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
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("<YOUR REGION>"))
                .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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# 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("<YOUR REGION>")) \
        .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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
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("<YOUR REGION>")).
         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)
    }
}

More

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

The specified report is queried successfully.

400

Invalid request.

500

Internal service error.

Error Codes

See Error Codes.