Help Center> Distributed Cache Service> API Reference> API V2> Instance Diagnosis> Querying a Specified Diagnosis Report
Updated on 2024-03-05 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.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

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

report_id

Yes

String

Diagnosis report ID.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

abnormal_item_sum

Integer

Total number of abnormal diagnosis items.

failed_item_sum

Integer

Total number of failed diagnosis items.

diagnosis_node_report_list

Array of DiagnosisNodeReport objects

Node diagnosis report list.

Table 3 DiagnosisNodeReport

Parameter

Type

Description

node_ip

String

Node IP address, for example, 192.168.0.234:6379.

az_code

String

Code of the AZ where the node is.

group_name

String

Name of the shard where the node is.

abnormal_sum

Integer

Total number of abnormal diagnosis items.

failed_sum

Integer

Total number of failed diagnosis items.

role

String

Node role.

Enumeration values:

  • master

  • slave

diagnosis_dimension_list

Array of DiagnosisDimension objects

Diagnosis dimension list.

command_time_taken_list

CommandTimeTakenList object

Command execution duration list.

Table 4 DiagnosisDimension

Parameter

Type

Description

name

String

Diagnosis dimension name.

Enumeration values:

  • network

  • storage

  • load

abnormal_num

Integer

Total number of abnormal diagnosis items.

failed_num

Integer

Total number of failed diagnosis items.

diagnosis_item_list

Array of DiagnosisItem objects

Diagnosis items.

Table 5 DiagnosisItem

Parameter

Type

Description

name

String

Diagnosis item name.

Enumeration values:

  • connection_num

  • rx_controlled

  • persistence

  • centralized_expiration

  • inner_memory_fragmentation

  • time_consuming_commands

  • hit_ratio

  • memory_usage

  • cpu_usage

cause_ids

Array of ConclusionItem objects

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

impact_ids

Array of ConclusionItem objects

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

advice_ids

Array of ConclusionItem objects

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

result

String

Diagnosis result.

Enumeration values:

  • failed

  • abnormal

  • normal

Table 6 ConclusionItem

Parameter

Type

Description

id

Integer

Conclusion ID.

params

Map<String,String>

Conclusion parameters.

Table 7 CommandTimeTakenList

Parameter

Type

Description

total_num

Integer

Total number of times that commands are executed.

total_usec_sum

Double

Total duration of command execution.

result

String

Command execution latency result.

Enumeration values:

  • succeed

  • failed

command_list

Array of CommandTimeTaken objects

Command execution latency statistics.

Table 8 CommandTimeTaken

Parameter

Type

Description

calls_sum

Integer

Number of calls.

usec_sum

Double

Total time consumed.

command_name

String

Command name.

per_usec

String

Duration percentage.

average_usec

Double

Average duration of calls.

Status code: 400

Table 9 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

Maximum: 1024

error_code

String

Error code.

Maximum: 9

error_ext_msg

String

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

Maximum: 1024

Status code: 500

Table 10 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

Maximum: 1024

error_code

String

Error code.

Maximum: 9

error_ext_msg

String

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

Maximum: 1024

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.

 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
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");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        DcsClient client = DcsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DcsRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowDiagnosisTaskDetailsRequest request = new ShowDiagnosisTaskDetailsRequest();
        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());
        }
    }
}
 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
# coding: utf-8

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.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = DcsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DcsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowDiagnosisTaskDetailsRequest()
        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)
 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
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")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := dcs.NewDcsClient(
        dcs.DcsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowDiagnosisTaskDetailsRequest{}
	response, err := client.ShowDiagnosisTaskDetails(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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.