创建重建索引任务

最近更新时间:2026-01-15 01:28:15

我的收藏

1. 接口描述

接口请求域名: cls.tencentcloudapi.com 。

创建重建索引任务
注意:

  • 单个日志主题同时仅允许运行一个重建索引任务,单个日志主题最多同时拥有10个重建索引任务记录,需删除不再需要的任务记录后才能新建索引任务。
  • 同一时间范围内的日志,仅允许重建一次索引,需删除之前的任务记录后才能再次重建。
  • 删除重建索引任务记录将恢复重建索引前的索引数据。
  • 所选时间范围对应日志写流量不能超出5TB。
  • 重建索引时间范围以日志时间为准,日志上传时间与重建索引时间范围有超过1小时的偏差时(例如16:00上传了一条02:00的日志到 CLS,重建00:00~12:00的日志索引)不会被重建且后续无法进行检索。新上报一条日志到已经被重建的日志时间范围时,也不会被重建且后续无法进行检索。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateRebuildIndexTask。
Version String 公共参数,本接口取值:2020-10-16。
Region String 公共参数,详见产品支持的 地域列表
TopicId String 日志主题ID
示例值:57f5808c-4a55-11eb-b378-0242ac130002
StartTime Integer 重建起始时间戳,毫秒
起始时间不允许超过日志生命周期
示例值:978653222
EndTime Integer 重建结束时间戳,毫秒
结束时间不晚于当前时间往前推15分钟
注意:建议提前使用“预估重建索引任务(EstimateRebuildIndexTask)”接口评估该时间范围重建索引涉及到的数据量及耗时,避免因数据量过大导致费用成本过高或耗时过长
示例值:978653222

3. 输出参数

参数名称 类型 描述
TaskId String 索引重建任务ID
示例值:57f5808c-4a55-11eb-b378-0242ac130002
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建重建索引任务

输入示例

POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateRebuildIndexTask
<公共请求参数>

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

输出示例

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

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure CAM签名/鉴权错误。
AuthFailure.UnauthorizedOperation 请求未授权。
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
OperationDenied 操作被拒绝。
ResourceNotFound 资源不存在。
ResourceNotFound.TopicNotExist 日志主题不存在。