Help Center/ ROMA Connect/ API Reference/ Message Integration APIs/ Message Management/ Querying a Message
Updated on 2023-06-29 GMT+08:00
View PDF
Share

Querying a Message

Function

This API is used to query the offset and content of a message. This API queries the message offset based on the timestamp and then queries the message content based on the offset.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Tenant's project ID.

instance_id

Yes

String

Instance ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

topic

Yes

String

Topic name.

asc

No

Boolean

Whether to sort messages by time.

start_time

No

String

Start time (Unix timestamp, in millisecond). This parameter is mandatory when querying the message offset.

end_time

No

String

End time (Unix timestamp, in millisecond). This parameter is mandatory when querying the message offset.

limit

No

String

Number of messages to query.

offset

No

String

Offset of the pagination query.

download

No

Boolean

Whether download is required.

message_offset

No

String

Message offset. This parameter is mandatory when querying the message content. If start_time and end_time are not empty, this parameter is invalid.

partition

No

String

Partition. This parameter is mandatory when querying the message content. If start_time and end_time are not empty, this parameter is invalid.

key

No

String

Message key.

message_id

No

String

Message ID.

tag

No

String

Message tag.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

messages

Array of messages objects

Message list.

total

Number

Total number of messages.

size

Number

Total number of returned messages.
Table 5 messages

Parameter

Type

Description

topic

String

Topic name.

partition

Integer

Partition where the message is located.

key

String

Message key.

value

String

Message content.

size

Integer

Message size.

timestamp

Integer

Topic name.

huge_message

Boolean

Big data flag.

message_offset

Integer

Message offset.

message_id

String

Message ID.

app_id

String

Application ID.

tag

String

Message tag.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

  • Query the message offset.

    GET https://{endpoint}/v2/{project_id}/mqs/instances/{instance_id}/messages?asc=false&end_time=1608609032042&limit=10&offset=0&start_time=1608608432042&topic=topic-test-mqs

  • Query the message content.

    GET https://{endpoint}/v2/{project_id}/mqs/instances/{instance_id}/messagesdownload=false&message_offset=0&partition=0&topic=topic-test-mqs

Example Responses

Status code: 200

OK

{
  "messages" : [ {
    "topic" : "topic-test",
    "partition" : 0,
    "value" : "hello world",
    "size" : 21,
    "timestamp" : 1607598463502,
    "huge_message" : false,
    "message_offset" : 4,
    "message_id" : "",
    "app_id" : "",
    "tag" : ""
  } ],
  "total" : 1,
  "size" : 1
}

Status code: 400

Bad Request

{
  "error_code" : 400,
  "error_msg" : "Bad Request"
}

Status code: 403

Forbidden

{
  "error_code" : 403,
  "error_msg" : "Forbidden"
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

403

Forbidden

Error Codes

See Error Codes.

Parent topic: Message Management