tencent cloud

APIs

CreateRebuildIndexTask

Unduh
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-06-10 15:02:09

1. API Description

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

This API is used to creates rebuild index tasks.
Note:
-A single log topic allows only one index reconstruction task at a time and can have up to 10 rebuild index task records. Delete task records that are no longer needed before creating an index task.
-Logs within the same time range only allow rebuilding indexes once. Delete previous task records before rebuilding again.
-Deleting a rebuild index task record restores the index data before rebuilding an index.
-The log write traffic of the selected time range cannot exceed 5TB.
-The index rebuilding time range is subject to the log time. When the log uploading time has a deviation exceeding one hour from the index rebuilding time range (for example, reporting a new log at 16:00 for 02:00 to CLS and rebuilding the log index for 00:00–12:00), the logs will not be rebuilt and cannot be retrieved subsequently. When reporting a new log to the reconstructed log time range, it will not be rebuilt and cannot be retrieved subsequently.

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: CreateRebuildIndexTask.
Version Yes String Common Params. The value used for this API: 2020-10-16.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
TopicId Yes String Log topic ID
StartTime Yes Integer Reconstruction start timestamp, in milliseconds
Start time cannot exceed log lifecycle
EndTime Yes Integer Reconstruction end timestamp, in milliseconds
End time not later than 15 minutes before the current time
Note: It is advisable to use the "EstimateRebuildIndexTask" API in advance to assess the data volume and duration involved in index rebuilding within this time range, avoiding excessive cost or duration due to overly large data volume.

3. Output Parameters

Parameter Name Type Description
TaskId String Reindexing task ID
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 This API is used to creates rebuild index tasks.

Input Example

POST / HTTP/1.1
Host: cls.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateRebuildIndexTask
<Common request parameters>

{
    "TopicId": "a5ce0c9c-xxxx-44a5-bc79-5f2190626bd0",
    "StartTime": 1234567890123,
    "EndTime": 1234567890456
}

Output Example

{
    "Response": {
        "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7",
        "TaskId": "6ef60bec-0242-43af-bb20-270359fb54ax"
    }
}

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 CAM signature/authentication error.
AuthFailure.UnauthorizedOperation Request unauthorized.
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameterValue Incorrect parameter value.
OperationDenied Operation denied.
ResourceNotFound The resource does not exist.
ResourceNotFound.TopicNotExist The log topic does not exist.

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan