tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

FetchMessageListByOffset

Last updated: 2023-07-05 15:57:39

1. API Description

Domain name for API request: ckafka.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.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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 Instance ID
Topic Yes String Topic name
Partition Yes Integer Partition ID
Offset Yes Integer Offset information
SinglePartitionRecordNumber No Integer The maximum number of messages that can be queried. Default value: 20. Maximum value: 20.

3. Output Parameters

Parameter Name Type Description
Result Array of ConsumerRecord Returned result. Note: The returned list does not display the message content (key and value). To query the message content, call the FetchMessageByOffset API.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying messages based on an offset

Input Example

https://ckafka.tencentcloudapi.com/?Action=FetchMessageListByOffset
&InstanceId=xxx
&Topic=xxx
&Partition=1
&Offset=1
&SinglePartitionRecordNumber=20
&<Common request parameters>

Output Example

{
    "Response": {
        "Result": [
            {
                "Topic": "xxx",
                "Partition": 2,
                "Offset": 1,
                "Key": "xxx",
                "Value": "xxx",
                "Timestamp": 1
            },
            {
                "Topic": "xxx",
                "Partition": 2,
                "Offset": 2,
                "Key": "xxx",
                "Value": "xxx",
                "Timestamp": 1
            }
        ],
        "RequestId": "62d589e0-53d5-47e0-95ff-237c48b8fb77"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy