Updated on 2024-02-01 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

Message engine.

Default: reliability

project_id

Yes

String

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

instance_id

Yes

String

Instance ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

topic

Yes

String

Topic name.

limit

No

String

Number of records to query.

offset

No

String

Offset, which is the position where the query starts. The value must be greater than or equal to 0.

key

No

String

Message key.

start_time

No

String

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

end_time

No

String

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

msg_id

No

String

Message ID.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

messages

Array of Message objects

Message list.

total

Number

Total number of messages.

Table 4 Message

Parameter

Type

Description

msg_id

String

Message ID.

instance_id

String

Instance ID.

topic

String

Topic name.

store_timestamp

Number

Time when the message is stored.

born_timestamp

Number

Time when the message is generated.

reconsume_times

Integer

Number of retry times.

body

String

Message body.

body_crc

Number

Message body checksum.

store_size

Number

Storage size.

property_list

Array of property_list objects

Message attribute list.

born_host

String

IP address of the host that generates the message.

store_host

String

IP address of the host that stores the message.

queue_id

Integer

Queue ID.

queue_offset

Integer

Offset in the queue.

Table 5 property_list

Parameter

Type

Description

name

String

Attribute name.

value

String

Attribute value.

Example Requests

Querying messages

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

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
50
51
52
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");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        rocketmqClient client = rocketmqClient.newBuilder()
                .withCredential(auth)
                .withRegion(rocketmqRegion.valueOf("<YOUR REGION>"))
                .build();
        ListMessagesRequest request = new ListMessagesRequest();
        request.withTopic("<topic>");
        request.withLimit("<limit>");
        request.withOffset("<offset>");
        request.withKey("<key>");
        request.withStartTime("<start_time>");
        request.withEndTime("<end_time>");
        request.withMsgId("<msg_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
34
35
36
# coding: utf-8

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = rocketmqClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(rocketmqRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListMessagesRequest()
        request.topic = "<topic>"
        request.limit = "<limit>"
        request.offset = "<offset>"
        request.key = "<key>"
        request.start_time = "<start_time>"
        request.end_time = "<end_time>"
        request.msg_id = "<msg_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
40
41
42
43
44
45
46
47
48
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")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := rocketmq.NewrocketmqClient(
        rocketmq.rocketmqClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListMessagesRequest{}
	request.Topic = "<topic>"
	limitRequest:= "<limit>"
	request.Limit = &limitRequest
	offsetRequest:= "<offset>"
	request.Offset = &offsetRequest
	keyRequest:= "<key>"
	request.Key = &keyRequest
	startTimeRequest:= "<start_time>"
	request.StartTime = &startTimeRequest
	endTimeRequest:= "<end_time>"
	request.EndTime = &endTimeRequest
	msgIdRequest:= "<msg_id>"
	request.MsgId = &msgIdRequest
	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.