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.
URI
GET /v2/{project_id}/instances/{instance_id}/management/topics/{topic}/partitions/{partition}/beginning-message
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 |
Definition: Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body. Constraints: N/A 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
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot