1. 接口描述
接口请求域名: csip.tencentcloudapi.com 。
获取日志索引信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeCLSLogIndexV3。 |
| Version | 是 | String | 公共参数,本接口取值:2022-11-21。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| Filters.N | 是 | Array of LogCLSFilter | 过滤条件 |
| MemberId.N | 否 | Array of String | 集团账号的成员id 示例值:["mem-32439480b741cb4e"] |
| Limit | 否 | Integer | limit限制 示例值:10 |
| Offset | 否 | Integer | offset 示例值:0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TopicIndexInfos | Array of LogTopicIndexInfo | 主题信息 |
| TotalCount | Integer | 总数 示例值:1 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 DescribeCLSLogIndexV3-test1
输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCLSLogIndexV3
<公共请求参数>
{
"Filters": [
{
"Key": "topicId",
"Values": [
"csip-test-logaccess-251308491-tcss-process_port_assets"
]
}
],
"Limit": 10,
"Offset": 0
}
输出示例
{
"Response": {
"TopicIndexInfos": [
{
"IncludeInternalFields": false,
"MetadataFlag": 0,
"ModifyTime": "2026-04-20 17:29:52",
"Rule": {
"DynamicIndex": {
"Status": true
},
"FullText": {
"CaseSensitive": false,
"ContainZH": true,
"Tokenizer": "@&()='\",;:<>[]{}/ \n\t\r\\"
},
"KeyValue": {
"CaseSensitive": false,
"KeyValues": [
{
"Key": "container_id",
"Value": {
"Alias": "",
"ContainZH": true,
"SqlFlag": true,
"Tokenizer": "@&?|#()='\",;:<>[]{}/ \n\t\r\\",
"Type": "text"
}
}
]
}
},
"Status": true,
"TopicId": "csip-test-logaccess-251308491-tcss-process_port_assets"
}
],
"TotalCount": 1,
"RequestId": "d5582c09-3297-4d31-902c-abc50f5a90be"
}
}
示例2 DescribeCLSLogIndexV3-test2
输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCLSLogIndexV3
<公共请求参数>
{
"Filters": [
{
"Key": "topicId",
"Values": [
"93-8056-4113-8f3e-82a4e16e"
]
}
],
"Limit": 1,
"Offset": 1
}
输出示例
{
"Response": {
"TopicIndexInfos": [
{
"IncludeInternalFields": true,
"MetadataFlag": 1,
"ModifyTime": "2026-05-14 10:00:00",
"Rule": {
"DynamicIndex": {
"Status": true
},
"FullText": {
"CaseSensitive": false,
"ContainZH": true,
"Tokenizer": "@&()='\",;:<>[]{}/ \n\t\r"
},
"KeyValue": {
"CaseSensitive": false,
"KeyValues": [
{
"Key": "level",
"Value": {
"Alias": "log_level",
"ContainZH": false,
"SqlFlag": true,
"Tokenizer": "@&()='\",;:<>[]{}/ \n\t\r",
"Type": "text"
}
}
]
},
"Tag": {
"CaseSensitive": false,
"KeyValues": [
{
"Key": "__FILENAME__",
"Value": {
"Alias": "filename",
"ContainZH": false,
"SqlFlag": true,
"Tokenizer": "@&()='\",;:<>[]{}/ \n\t\r",
"Type": "text"
}
}
]
}
},
"Status": true,
"TopicId": "mock-topic-id-251308491"
}
],
"TotalCount": 1,
"RequestId": "e744f19b-71f4-4583-80e2-8dec444150f2"
}
}
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签名/鉴权错误。 |
| DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
| FailedOperation | 操作失败。 |
| FailedOperation.DasbAmountNotEnough | FailedOperation.DasbAmountNotEnough |
| FailedOperation.DasbErrorCode | FailedOperation.DasbErrorCode |
| FailedOperation.DasbInvalidSecretId | FailedOperation.DasbInvalidSecretId |
| FailedOperation.DasbInvalidSecretKey | FailedOperation.DasbInvalidSecretKey |
| InternalError | 内部错误。 |
| InvalidFilter | 无效的过滤器 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.DecryptError | Decrypt error |
| InvalidParameter.ResourceId | InvalidParameter.ResourceId |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.SQLQueryFailed | SQL 查询失败 |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| RegionError | 地域错误 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| ResourceInUse | 资源被占用。 |
| ResourceInsufficient | 资源不足。 |
| ResourceInsufficient.LogAnalysisQuantityInsufficient | 日志分析量不足 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable | 资源不可用。 |
| ResourcesSoldOut | 资源售罄。 |
| UnauthorizedOperation | 未授权操作。 |
| UnauthorizedOperation.CloudAudit | 未授权操作“操作审计”产品 |
| UnauthorizedOperation.Cos | 未授权操作“对象存储”产品 |
| UnauthorizedOperation.NoPermission | UnauthorizedOperation.NoPermission |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |