DescribeIndexs
最近更新时间: 2025-10-20 17:05:57
1. 接口描述
接口请求域名： cls.api3.fincloud.tencent.cn。
本接口用于获取索引配置列表
默认接口请求频率限制：20次/秒。
接口更新时间：2023-05-16 17:54:09。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeIndexs |
| Version | 是 | 否 | String | 公共参数，本接口取值：2020-10-16 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| Filters | 否 | 否 | Array of Filter | <br><li> topicName按照【日志主题名称】进行过滤。类型：String必选：否<br><li> topicId按照【日志主题ID】进行过滤。类型：String必选：否<br><li> logsetId按照【日志集ID】进行过滤，可通过调用DescribeLogsets查询已创建的日志集列表或登录控制台进行查看；也可以调用CreateLogset创建新的日志集。类型：String必选：否<br><li> tagKey按照【标签键】进行过滤。类型：String必选：否<br><li> tag:tagKey按照【标签键值对】进行过滤。tag-key使用具体的标签键进行替换。使用请参考示例2。类型：String必选：否 |
| Offset | 否 | 否 | Int64 | 分页的偏移量，默认值为0。 |
| Limit | 否 | 否 | Int64 | 分页单页限制数目，默认值为20，最大值100。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TopicIndexInfos | TopicIndexInfo | 日志主题的索引信息列表 |
| TotalCount | Int64 | 总数目 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.TopicIsolated | 日志主题已隔离。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.ACLFailed | ACL校验失败。 |
| OperationDenied.AccountDestroy | 账户已销毁。 |
| OperationDenied.AccountIsolate | 账户欠费。 |
| OperationDenied.AccountNotExists | 账户不存在。 |
| ResourceNotFound.IndexNotExist | 索引不存在。 |
| ResourceNotFound.TopicNotExist | 日志主题不存在。 |