Querying Messages

Function

This API is used to query messages.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
engine	Yes	String	Message engine.
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	Key of a message.
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?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
}