Updated on 2025-08-13 GMT+08:00

Querying Messages

Function

This API is used to query messages.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{engine}/{project_id}/instances/{instance_id}/messages

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

engine

Yes

String

Parameter description:

Message engine.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

project_id

Yes

String

Parameter description:

Project ID. For details, see Obtaining a Project ID.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

instance_id

Yes

String

Parameter description:

Instance ID. To obtain it, log in to the RocketMQ console and find the instance ID on the RocketMQ instance details page.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

topic

Yes

String

Parameter description:

Topic name.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

queue

No

String

Parameter description:

Queue.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

limit

No

String

Parameter description:

Number of records to query.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

offset

No

String

Parameter description:

Offset where the query starts.

Constraints:

N/A

Value range:

≥ 0

Default value:

N/A

key

No

String

Parameter description:

Key of a message.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

start_time

No

String

Parameter description:

Start time.

Constraints:

This parameter is mandatory when msg_id is not used for query.

Value range:

N/A

Default value:

N/A

end_time

No

String

Parameter description:

End time.

Constraints:

This parameter is mandatory when msg_id is not used for query.

Value range:

N/A

Default value:

N/A

msg_id

No

String

Parameter description:

Message ID.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

messages

Array of Message objects

Parameter description:

Message list.

total

Number

Parameter description:

Total number of messages.

Value range:

N/A

Table 4 Message

Parameter

Type

Description

msg_id

String

Parameter description:

Message ID.

Value range:

N/A

instance_id

String

Parameter description:

Instance ID.

Value range:

N/A

topic

String

Parameter description:

Topic name.

Value range:

N/A

store_timestamp

Number

Parameter description:

Time when the message is stored.

Value range:

N/A

born_timestamp

Number

Parameter description:

Time when the message is generated.

Value range:

N/A

reconsume_times

Integer

Parameter description:

Number of retry times.

Value range:

N/A

body

String

Parameter description:

Message body.

Value range:

N/A

body_crc

Number

Parameter description:

Message body checksum.

Value range:

N/A

store_size

Number

Parameter description:

Storage size.

Value range:

N/A

property_list

Array of property_list objects

Parameter description:

Message attribute list.

born_host

String

Parameter description:

IP address of the host that generates the message.

Value range:

N/A

store_host

String

Parameter description:

IP address of the host that stores the message.

Value range:

N/A

queue_id

Integer

Parameter description:

Queue ID.

Value range:

N/A

queue_offset

Integer

Parameter description:

Offset in the queue.

Value range:

N/A

Table 5 property_list

Parameter

Type

Description

name

String

Parameter description:

Attribute name.

Value range:

N/A

value

String

Parameter description:

Attribute value.

Value range:

N/A

Example Requests

Querying messages

GET https://{endpoint}/v2/{engine}/{project_id}/instances/{instance_id}/messages?topic={topic}

Example Responses

Status code: 200

Messages queried successfully.

{
  "messages" : [ {
    "msg_id" : "C0A807C9000027740000000000000030",
    "instance_id" : "11c45539-xxxx-xxxx-xxxx-812c41f61f30",
    "topic" : "topic-test",
    "store_timestamp" : 1648888166319,
    "born_timestamp" : 1648888166275,
    "reconsume_times" : 0,
    "body" : "xxxx",
    "body_crc" : 1932557065,
    "store_size" : 175,
    "property_list" : [ {
      "name" : "KEYS",
      "value" : ""
    }, {
      "name" : "UNIQ_KEY",
      "value" : "7F00000123DC6E0BE85808B037820000"
    }, {
      "name" : "CLUSTER",
      "value" : "DmsCluster"
    }, {
      "name" : "TAGS",
      "value" : ""
    } ],
    "born_host" : "192.168.0.66:50098",
    "store_host" : "192.168.7.201:10100",
    "queue_id" : 2,
    "queue_offset" : 0
  } ],
  "total" : 1
}

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

    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();
        ListMessagesRequest request = new ListMessagesRequest();
        request.withEngine(ListMessagesRequest.EngineEnum.fromValue("{engine}"));
        request.withInstanceId("{instance_id}");
        try {
            ListMessagesResponse response = client.listMessages(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 = ListMessagesRequest()
        request.engine = "{engine}"
        request.instance_id = "{instance_id}"
        response = client.list_messages(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.ListMessagesRequest{}
	request.Engine = model.GetListMessagesRequestEngineEnum().ENGINE
	request.InstanceId = "{instance_id}"
	response, err := client.ListMessages(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

Messages queried successfully.

Error Codes

See Error Codes.