Domain name for API request: ckafka.intl.tencentcloudapi.com.
This API is used to query the message list based on an offset.
A maximum of 1 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: FetchMessageListByOffset. |
| Version | Yes | String | Common Params. The value used for this API: 2019-08-19. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | ckafka cluster instance Id For reference: DescribeInstances |
| Topic | Yes | String | Topic name |
| Partition | Yes | Integer | Partition id |
| Offset | Yes | Integer | Location info |
| SinglePartitionRecordNumber | No | Integer | Maximum number of query results. Default value: 20. Maximum value: 20. |
| Parameter Name | Type | Description |
|---|---|---|
| Result | Array of ConsumerRecord | Return result. Note that the list does not return specific message content (key, value). If necessary, query specific message content using the FetchMessageByOffset API. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
https://ckafka.intl.tencentcloudapi.com/?Action=FetchMessageListByOffset
&InstanceId=ckafka-test
&Topic=topic-test
&Partition=1
&Offset=1
&SinglePartitionRecordNumber=20
&<Common request parameters>
{
"Response": {
"Result": [
{
"Topic": "topic-test",
"Partition": 0,
"Offset": 0,
"Key": "key",
"Value": "value",
"Timestamp": 0,
"Headers": "head"
}
],
"RequestId": "84770b4b-df34-4ccf-8e22-41d3b1d0fe0d"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| InternalError | Internal error. |
文档反馈