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

查询主题列表

功能介绍

该接口用于查询指定RocketMQ实例的Topic列表。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

instance_id

String

实例ID。

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

查询数量,取值范围为1~50。

offset

Integer

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

请求参数

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

total

Integer

Topic总数。

max

Integer

最大可创建Topic数量。

remaining

Integer

剩余可创建Topic数量。

next_offset

Integer

下个分页的offset。

previous_offset

Integer

上个分页的offset。

topics

Array of Topic objects

Topic列表。

表4 Topic

参数

参数类型

描述

name

String

Topic名称。

total_read_queue_num

Number

总读队列个数。

total_write_queue_num

Number

总写队列个数。

permission

String

权限。

brokers

Array of brokers objects

关联的代理。

message_type

String

消息类型(RocketMQ实例5.x版本才包含此参数)。

表5 brokers

参数

参数类型

描述

broker_name

String

代理名称。

read_queue_num

Number

读队列个数。

write_queue_num

Number

写队列个数。

请求示例

查询指定RocketMQ实例的主题列表,查询数量为10,从offset=0开始查询。

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics?offset=0&limit=10

响应示例

状态码: 200

查询成功。

{
  "total" : "3,",
  "max" : "2000,",
  "remaining" : "1997,",
  "next_offset" : "-1,",
  "previous_offset" : "-1,",
  "topics" : [ {
    "name" : "topic-1",
    "total_read_queue_num" : 3,
    "total_write_queue_num" : 3,
    "permission" : "all",
    "brokers" : [ {
      "broker_name" : "broker-0",
      "read_queue_num" : 3,
      "write_queue_num" : 3
    } ],
    "message_type" : "NORMAL"
  }, {
    "name" : "topic-2",
    "total_read_queue_num" : 3,
    "total_write_queue_num" : 3,
    "permission" : "all",
    "brokers" : [ {
      "broker_name" : "broker-0",
      "read_queue_num" : 3,
      "write_queue_num" : 3
    } ],
    "message_type" : "NORMAL"
  }, {
    "name" : "topic-3",
    "total_read_queue_num" : 3,
    "total_write_queue_num" : 3,
    "permission" : "all",
    "brokers" : [ {
      "broker_name" : "broker-0",
      "read_queue_num" : 3,
      "write_queue_num" : 3
    } ],
    "message_type" : "NORMAL"
  } ]
}

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

    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();
        ListRocketInstanceTopicsRequest request = new ListRocketInstanceTopicsRequest();
        request.withInstanceId("{instance_id}");
        try {
            ListRocketInstanceTopicsResponse response = client.listRocketInstanceTopics(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
# 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 = ListRocketInstanceTopicsRequest()
        request.instance_id = "{instance_id}"
        response = client.list_rocket_instance_topics(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
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.ListRocketInstanceTopicsRequest{}
	request.InstanceId = "{instance_id}"
	response, err := client.ListRocketInstanceTopics(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

查询成功。

错误码

请参见错误码