1. 接口描述
接口请求域名: cls.tencentcloudapi.com 。
获取重建索引任务列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeRebuildIndexTasks。 |
| Version | 是 | String | 公共参数,本接口取值:2020-10-16。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| TopicId | 是 | String | 日志主题ID 示例值:57f5808c-4a55-11eb-b378-0242ac130002 |
| TaskId | 否 | String | 索引重建任务ID 示例值:57f5808c-4a55-11eb-b378-0242ac130002 |
| Status | 否 | String | 索引重建任务状态,不填返回所有状态任务列表,多种状态之间用逗号分隔,0:索引重建任务已创建,1:已创建索引重建资源,2:重建中,3:重建完成,4:重建成功(可检索),5:任务取消,6:元数据和索引已删除 示例值:0,1,2,3 |
| Offset | 否 | Integer | 分页的偏移量,默认值为0。 示例值:0 |
| Limit | 否 | Integer | 分页单页限制数目,默认值为10,最大值20。 示例值:10 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RebuildTasks | Array of RebuildIndexTaskInfo | 索引重建任务列表 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取索引重建任务列表
输入示例
POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRebuildIndexTasks
<公共请求参数>
{
"TopicId": "826f8b26-b054-4a0d-xxxx-f3d609f5e0ea"
}
输出示例
{
"Response": {
"RebuildTasks": [
{
"TaskId": "02f3e53d-d120-477e-xxxx-cbed37247d97",
"Status": 0,
"StatusMessage": "",
"StartTime": 1234567890123,
"EndTime": 1234567890234,
"RemainTime": 1000,
"CreateTime": 1234567890111,
"UpdateTime": 0,
"Progress": 0.0
}
],
"RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| AuthFailure.UnauthorizedOperation | 请求未授权。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.AccountNotExists | 账户不存在。 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.TopicNotExist | 日志主题不存在。 |