文档首页/ 分布式消息服务RocketMQ版/ API参考/ API V2(推荐)/ 实例诊断/ 查询实例诊断报告 - ShowDiagnosisReport
更新时间:2025-11-27 GMT+08:00
分享

查询实例诊断报告 - ShowDiagnosisReport

功能介绍

查询实例诊断报告。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

engine

String

参数解释

引擎。

约束限制

不涉及。

取值范围

  • rocketmq:RocketMQ消息引擎。

  • reliability:RocketMQ消息引擎别称。

默认取值

不涉及。

project_id

String

参数解释

项目ID,获取方式请参见获取项目ID

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

report_id

String

参数解释

报告ID。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

report_id

String

参数解释

报告ID。

取值范围

不涉及。

group_name

String

参数解释

消费组名称。

取值范围

不涉及。

consumer_nums

Integer

参数解释

消费者数量。

取值范围

不涉及。

status

String

参数解释

状态。

取值范围

  • diagnosing:诊断中。

  • failed:诊断失败。

  • deleted:手动删除。

  • finished:诊断完成。

  • normal:诊断结果正常。

  • abnormal:诊断结果异常。

creat_at

Long

参数解释

生成时间。

取值范围

不涉及。

abnormal_item_sum

Integer

参数解释

异常项数量。

取值范围

不涉及。

faulted_node_sum

Integer

参数解释

异常节点数量。

取值范围

不涉及。

online

Boolean

参数解释

是否在线。

取值范围

  • true:在线。

  • false:不在线。

message_accumulation

Integer

参数解释

消息堆积数。

取值范围

不涉及。

subscription_consistency

Boolean

参数解释

订阅一致性。

取值范围

  • true:订阅关系一致。

  • false:订阅关系不一致。

subscriptions

Array of SubscriptionEntity objects

参数解释

订阅者列表。

取值范围

不涉及。

diagnosis_node_report_list

Array of DiagnosisNodeReportEntity objects

参数解释

诊断节点报告列表。

取值范围

不涉及。

表3 SubscriptionEntity

参数

参数类型

描述

topic_name

String

参数解释

Topic名称。

取值范围

不涉及。

consumers_in_tags

Array of ConsumersInTagEntity objects

参数解释

消费者标签列表。

取值范围

不涉及。

表4 ConsumersInTagEntity

参数

参数类型

描述

consumers

Array of strings

参数解释

消费者列表。

取值范围

不涉及。

tag_name

String

参数解释

标签名。

取值范围

不涉及。

表5 DiagnosisNodeReportEntity

参数

参数类型

描述

node_id

String

参数解释

节点ID。

取值范围

不涉及。

is_faulted

Boolean

参数解释

是否故障。

取值范围

  • true:故障

  • false:没有故障。

abnormal_item_sum

Integer

参数解释

异常项总数。

取值范围

不涉及。

message_accumulation

Integer

参数解释

消息堆积数。

取值范围

不涉及。

dead_lock

Boolean

参数解释

是否为死锁。

取值范围

  • true:是死锁。

  • false:不是死锁。

deadlock_thread

String

参数解释

死锁线程。

取值范围

不涉及。

stack_id

String

参数解释

线程ID。

取值范围

不涉及。

is_pop

Boolean

参数解释

是否为pop消费模式。

取值范围

  • true:是pop消费模式。

  • false:不是pop消费模式。

consume_type

String

参数解释

消费类型。

取值范围

不涉及。

请求示例

查询实例诊断报告。

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

响应示例

状态码: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,
  "subscriptions" : [ ],
  "diagnosis_node_report_list" : [ ]
}

SDK代码示例

SDK代码示例如下。

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

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

success

错误码

请参见错误码

相关文档