Updated on 2025-12-18 GMT+08:00

Querying an Instance Diagnosis Report

Function

This API is used to query an instance diagnosis report.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

engine

Yes

String

Definition

Engine.

Constraints

N/A

Range

  • rocketmq: RocketMQ message engine.

  • reliability: RocketMQ message engine alias.

Default Value

N/A

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:

Report ID.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

report_id

String

Definition:

Report ID.

Range:

N/A

group_name

String

Definition:

Consumer group name.

Range:

N/A

consumer_nums

Integer

Definition:

Number of consumers.

Range:

N/A

status

String

Definition

Status.

Range

  • diagnosing

  • failed

  • deleted (manually)

  • finished

  • normal: No problems found.

  • abnormal: Problems found.

creat_at

Long

Definition:

Generation time.

Range:

N/A

abnormal_item_sum

Integer

Definition:

Number of abnormal items.

Range:

N/A

faulted_node_sum

Integer

Definition:

Number of abnormal nodes.

Range:

N/A

online

Boolean

Definition

Online or not.

Range

  • true: Yes

  • false: No

message_accumulation

Integer

Definition:

Number of stacked messages.

Range:

N/A

subscription_consistency

Boolean

Definition

Subscription consistency.

Range

  • true: Yes

  • false: No

duplicate_client_id

Boolean

Definition

Whether a duplicate client ID.

Range

  • true: Yes

  • false: No

different_consumer_type

Boolean

Definition

Whether any inconsistent types of consumption.

Range

  • true: Yes

  • false: No

subscriptions

Array of SubscriptionEntity objects

Definition:

Subscriber list.

Range:

N/A

diagnosis_node_report_list

Array of DiagnosisNodeReportEntity objects

Definition:

Diagnosis node report list.

Range:

N/A

Table 3 SubscriptionEntity

Parameter

Type

Description

topic_name

String

Definition

Topic name.

Range

N/A

consumers_in_tags

Array of ConsumersInTagEntity objects

Definition

Consumer tag list.

Range

N/A

Table 4 ConsumersInTagEntity

Parameter

Type

Description

consumers

Array of strings

Definition

Consumer list.

Range

N/A

tag_name

String

Definition

Tag name.

Range

N/A

Table 5 DiagnosisNodeReportEntity

Parameter

Type

Description

node_id

String

Definition

Node ID.

Range

N/A

is_faulted

Boolean

Definition

Whether a node is faulty.

Range

  • true: Yes

  • false: No

abnormal_item_sum

Integer

Definition

Total number of exceptions.

Range

N/A

message_accumulation

Integer

Definition

Number of stacked messages.

Range

N/A

dead_lock

Boolean

Definition

Whether a deadlock occurs.

Range

  • true: Yes

  • false: No

deadlock_thread

String

Definition

Deadlock thread.

Range

N/A

stack_id

String

Definition

Thread ID.

Range

N/A

is_pop

Boolean

Definition

Whether pop consumption is used.

Range

  • true: Yes

  • false: No

consume_type

String

Definition

Consumption type.

Range

N/A

Example Requests

Querying an instance diagnosis report

GET https://{endpoint}/v2/{engine}/{project_id}/diagnosis/{report_id}

Example Responses

Status code: 200

success

{
  "report_id" : "3019dd35-361c-4631-a8d8-3578c0a7d102",
  "group_name" : "test",
  "consumer_nums" : "0,",
  "status" : "finished",
  "creat_at" : 1748402725731,
  "abnormal_item_sum" : 1,
  "faulted_node_sum" : 0,
  "online" : false,
  "message_accumulation" : 0,
  "subscription_consistency" : true,
  "duplicate_client_id" : false,
  "different_consumer_type" : false,
  "subscriptions" : [ ],
  "diagnosis_node_report_list" : [ ]
}

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
46
47
48
49
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.rocketmq.v2.region.RocketMQRegion;
import com.huaweicloud.sdk.rocketmq.v2.*;
import com.huaweicloud.sdk.rocketmq.v2.model.*;


public class ShowDiagnosisReportSolution {

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

        RocketMQClient client = RocketMQClient.newBuilder()
                .withCredential(auth)
                .withRegion(RocketMQRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowDiagnosisReportRequest request = new ShowDiagnosisReportRequest();
        request.withEngine("{engine}");
        request.withReportId("{report_id}");
        try {
            ShowDiagnosisReportResponse response = client.showDiagnosisReport(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
30
31
32
33
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkrocketmq.v2.region.rocketmq_region import RocketMQRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkrocketmq.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 = RocketMQClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(RocketMQRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowDiagnosisReportRequest()
        request.engine = "{engine}"
        request.report_id = "{report_id}"
        response = client.show_diagnosis_report(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
36
37
38
39
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    rocketmq "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := rocketmq.NewRocketMQClient(
        rocketmq.RocketMQClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowDiagnosisReportRequest{}
	request.Engine = "{engine}"
	request.ReportId = "{report_id}"
	response, err := client.ShowDiagnosisReport(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

success

Error Codes

See Error Codes.