更新时间:2024-07-05 GMT+08:00

查询消费列表或详情

功能介绍

查询消费列表或详情。

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/instances/{instance_id}/groups/{group}/topics

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

instance_id

String

实例ID。

group

String

消费组名称。

表2 Query参数

参数

是否必选

参数类型

描述

topic

String

待查询的Topic,不指定时查询Topic列表,指定时查询详情。

limit

Integer

当次查询返回的最大个数,默认值为10,取值范围为1~50。

offset

Integer

偏移量,表示从此偏移量开始查询, offset大于等于0。

请求参数

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

topics

Array of strings

Topic列表(当查询Topic消费“列表”时才显示此参数)。

total

Integer

Topic总数(当查询Topic消费“列表”时才显示此参数)。

lag

Long

消费堆积总数。

max_offset

Long

消息总数。

consumer_offset

Long

已消费消息数。

brokers

Array of Brokers objects

Topic关联代理(当查询Topic消费“详情”才显示此参数)。

表4 Brokers

参数

参数类型

描述

broker_name

String

Topic关联代理名称。

queues

Array of Queue objects

关联代理的队列详情。

表5 Queue

参数

参数类型

描述

id

Integer

队列ID。

lag

Long

队列消费堆积总数。

broker_offset

Long

队列消息总数。

consumer_offset

Long

已消费消息数。

last_message_time

Long

最新消费消息的存储时间,unix毫秒时间戳格式。

请求示例

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups/{group}/topics?topic=test0001

响应示例

状态码: 200

查询消费列表或详情成功。

  • 查询消费组的Topic列表成功。

    {
      "topics" : [ "topic-test" ],
      "total" : 1
    }
  • 查询消费组详情成功。

    {
      "lag" : 0,
      "max_offset" : 1,
      "consumer_offset" : 1,
      "brokers" : [ {
        "broker_name" : "broker-0",
        "queues" : [ {
          "id" : 0,
          "lag" : 0,
          "broker_offset" : 0,
          "consumer_offset" : 0,
          "last_message_time" : 0
        }, {
          "id" : 1,
          "lag" : 0,
          "broker_offset" : 1,
          "consumer_offset" : 1,
          "last_message_time" : 1679398537088
        }, {
          "id" : 0,
          "lag" : 0,
          "broker_offset" : 0,
          "consumer_offset" : 0,
          "last_message_time" : 0
        } ]
      } ]
    }

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 ShowConsumerListOrDetailsSolution {

    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();
        ShowConsumerListOrDetailsRequest request = new ShowConsumerListOrDetailsRequest();
        request.withInstanceId("{instance_id}");
        request.withGroup("{group}");
        try {
            ShowConsumerListOrDetailsResponse response = client.showConsumerListOrDetails(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 = ShowConsumerListOrDetailsRequest()
        request.instance_id = "{instance_id}"
        request.group = "{group}"
        response = client.show_consumer_list_or_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
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.ShowConsumerListOrDetailsRequest{}
	request.InstanceId = "{instance_id}"
	request.Group = "{group}"
	response, err := client.ShowConsumerListOrDetails(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

查询消费列表或详情成功。

错误码

请参见错误码