Querying the Topic List
Function
This API is used to query the topic list of a RocketMQ instance.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/instances/{instance_id}/topics
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Definition Project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A |
|
instance_id |
Yes |
String |
Definition Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body. Constraints N/A Range N/A Default Value N/A |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
limit |
No |
Integer |
Definition Number of records to query. Constraints N/A Range 1–50 Default value N/A |
|
offset |
No |
Integer |
Definition Offset where the query starts. Constraints N/A Range ≥ 0 Default value N/A |
Request Parameters
None
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
total |
Integer |
Definition Total number of topics. Range N/A |
|
max |
Integer |
Definition Maximum number of topics that can be created. Range N/A |
|
remaining |
Integer |
Definition Remaining number of topics that can be created. Range N/A |
|
next_offset |
Integer |
Definition Offset of the next page. Range N/A |
|
previous_offset |
Integer |
Definition Offset of the previous page. Range N/A |
|
topics |
Array of Topic objects |
Definition Remaining number of topics that can be created. |
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
String |
Definition Topic name. Range N/A |
|
total_read_queue_num |
Number |
Definition Total number of read queues. Range N/A |
|
total_write_queue_num |
Number |
Definition Total number of write queues. Range N/A |
|
permission |
String |
Definition Permission. Range
|
|
brokers |
Array of brokers objects |
Definition Associated broker. |
|
message_type |
String |
Definition Message type (available only for RocketMQ 5.x instances). Range
|
Example Requests
Querying a list of 10 topics of a specified RocketMQ instance from offset=0
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics?offset=0&limit=10
Example Responses
Status code: 200
Query succeeded.
{
"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 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 |
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) } } |
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 |
Query succeeded. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot