Help Center/ Distributed Message Service for Kafka/ API Reference/ APIs V2 (Recommended)/ Managing Messages/ Querying Offset of the Earliest Message in a Partition
Updated on 2025-05-21 GMT+08:00

Querying Offset of the Earliest Message in a Partition

Function

This API is used to query the offset of the earliest message in a partition.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/instances/{instance_id}/management/topics/{topic}/partitions/{partition}/beginning-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

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

topic

String

Parameter description:

Topic name.

Value range:

N/A

partition

Integer

Parameter description:

Partition ID.

Value range:

N/A

offset

Integer

Parameter description:

Message offset.

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}/beginning-message

Example Responses

Status code: 200

The offset of the earliest message in a partition is queried successfully.

{
  "topic" : "mytest",
  "partition" : 0,
  "offset" : 9,
  "timestamp" : 1568125039164
}

Status Codes

Status Code

Description

200

The offset of the earliest message in a partition is queried successfully.

Error Codes

See Error Codes.