Querying a Message with a Specified Offset

Function

This API is used to query a message with a specified offset.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/instances/{instance_id}/management/topics/{topic}/partitions/{partition}/message

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
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 Kafka console and find the instance ID on the Kafka instance details page. Constraints: N/A Value range: N/A Default value: N/A
topic	Yes	String	Parameter description: Topic name. Constraints: A topic name must start with a letter and can only contain letters, hyphens (-), underscores (_), and digits. Value range: N/A Default value: N/A
partition	Yes	Integer	Parameter description: Partition ID. Constraints: N/A Value range: N/A Default value: N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
message_offset	Yes	String	Parameter description: Message offset. 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
message	Array of ShowPartitionMessageEntity objects	Parameter description: Message list.

**Table 4** ShowPartitionMessageEntity
Parameter	Type	Description
key	String	Parameter description: Message key. Value range: N/A
value	String	Parameter description: Message content. Value range: N/A
topic	String	Parameter description: Topic name. Value range: N/A
partition	Integer	Parameter description: Partition ID. Value range: N/A
message_offset	Long	Parameter description: Message offset. Value range: N/A
size	Integer	Parameter description: Message size, in bytes. Value range: N/A
timestamp	Long	Parameter description: Message production time. The value is a Unix timestamp. The unit is millisecond. Value range: N/A

Example Requests

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/management/topics/{topic}/partitions/{partition}/message?message_offset={message_offset}

Example Responses

Status code: 200

The message with the specified offset is queried successfully.

{
  "message" : [ {
    "topic" : "mytest",
    "partition" : 0,
    "message_offset" : 7,
    "key" : null,
    "value" : "kasjdf",
    "size" : 6,
    "timestamp" : 1568125036045
  } ]
}