tencent cloud

APIs

DokumentasiAPIsCloud Log ServiceIndex APIsDescribeRebuildIndexTasks

DescribeRebuildIndexTasks

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

1. API Description

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

This API is used to obtain the list of rebuild index tasks.

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: DescribeRebuildIndexTasks.
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.
TaskId No String

Index rebuild task ID
Status No String

Index rebuild task status. Leave it blank to return the task list of all statuses. Multiple statuses are separated by commas.

Enumeration value:

  • 0: Reindexing task created
  • 1: Creating reindexing resources
  • 2: Index rebuild resource created
  • 3: Rebuilding
  • 4: Suspension
  • 5: Rebuild complete
  • 6: Rebuild successful (retrievable)
  • 7: Rebuilding failed
  • 8: Task cancellation
  • 9: Metadata and index deleted
Offset No Integer

Pagination offset. Default value: 0.
Limit No Integer

Number of entries per page. Default value: 10. Maximum value: 20.

3. Output Parameters

Parameter Name Type Description
RebuildTasks Array of RebuildIndexTaskInfo

Index rebuild task list
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 Obtaining the List of Index Rebuilding Tasks

Input Example

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

{
    "TopicId": "826f8b26-b054-4a0d-xxxx-f3d609f5e0ea"
}

Output Example

{
    "Response": {
        "RebuildTasks": [
            {
                "TaskId": "02f3e53d-d120-477e-xxxx-cbed37247d97",
                "Status": 0,
                "StatusMessage": "",
                "StartTime": 1234567890123,
                "EndTime": 1234567890234,
                "RemainTime": 1000,
                "CreateTime": 1234567890111,
                "UpdateTime": 0,
                "Progress": 0
            }
        ],
        "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
    }
}

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.
OperationDenied.AccountNotExists The account does not exist.
ResourceNotFound The resource does not exist.
ResourceNotFound.TopicNotExist The log topic does not exist.
Topik sebelumnya: EstimateRebuildIndexTaskTopik selanjutnya: DescribePartitions

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan