tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeOffsetByTime

Last updated: 2024-12-04 15:34:42

1. API Description

Domain name for API request: dts.intl.tencentcloudapi.com.

This API is used to query the latest offset before the specified time in KafkaTopic.The offset output by the interface is the closest offset to this time.If the input time is much later than the current time, the output is equivalent to the latest offset;If the input time is much earlier than the current time, the output is equivalent to the oldest offset;If the input is empty, the default time is 0, which is the oldest offset to be queried.

A maximum of 20 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: DescribeOffsetByTime.
Version Yes String Common Params. The value used for this API: 2021-12-06.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
SubscribeId Yes String Data subscription instance ID
Time Yes String Timestamp, the format is: Y-m-d h:m:s. If the input time is much later than the current time, this is equivalent to the latest offset; if the input time is much earlier than the current time, this is equivalent to the oldest offset; if the input is empty, the default time is 0, which is the oldest offset to be queried.

3. Output Parameters

Parameter Name Type Description
Items Array of OffsetTimeMap Time and Offset response.
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.

4. Example

Example1 Querying the checkpoint messages in Kafka based on time

This example shows you how to query the most recent checkpoint and its offset before the specified time in the KafkaTopic.

Input Example

POST / HTTP/1.1
Host: dts.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeOffsetByTime
<Common Request Parameters>

{
    "SubscribeId": "subs-9jyki7hniw",
    "Time": "2023-05-15 16:31:30"
}

Output Example

{
    "Response": {
        "Items": [
            {
                "Offset": 62856,
                "PartitionNo": 0
            },
            {
                "Offset": 62842,
                "PartitionNo": 1
            },
            {
                "Offset": 62842,
                "PartitionNo": 2
            },
            {
                "Offset": 62842,
                "PartitionNo": 3
            }
        ],
        "RequestId": "087e2780-f3bc-11ed-8dff-ff5f3734b02b"
    }
}

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
AuthFailure The CAM signature/authentication information is incorrect.
AuthFailure.AuthFailureError Authentication failed.
FailedOperation Operation failed.
FailedOperation.FailedOperationError The operation failed.
InternalError An internal error occurred.
InternalError.InternalErrorError An internal error occurred.
InvalidParameter The parameter is incorrect.
InvalidParameter.InvalidParameterError The parameter is invalid.
InvalidParameterValue Invalid parameter value.
InvalidParameterValue.InvalidParameterValueError The parameter is invalid.
OperationDenied The operation was denied.
OperationDenied.OperationDeniedError The operation was denied.
ResourceNotFound The resource does not exist.
ResourceNotFound.ResourceNotFoundError The resource was not found.
UnauthorizedOperation The operation is unauthorized.
UnauthorizedOperation.UnauthorizedOperationError The operation is unauthorized.
UnsupportedOperation The operation is not supported.
UnsupportedOperation.UnsupportedOperationError The operation is not supported.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy