Domain name for API request: csip.intl.tencentcloudapi.com.
Get log index information
A maximum of 20 requests can be initiated per second for this API.
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: DescribeCLSLogIndexV3. |
| Version | Yes | String | Common Params. The value used for this API: 2022-11-21. |
| Region | No | String | Common Params. This parameter is not required. |
| Filters.N | Yes | Array of LogCLSFilter | Filter conditions. |
| MemberId.N | No | Array of String | Group account member id |
| Limit | No | Integer | limit |
| Offset | No | Integer | offset |
| Parameter Name | Type | Description |
|---|---|---|
| TopicIndexInfos | Array of LogTopicIndexInfo | Topic information |
| TotalCount | Integer | Total. |
| 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. |
POST / HTTP/1.1
Host: csip.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCLSLogIndexV3
<Common request parameters>
{
"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"
}
}POST / HTTP/1.1
Host: csip.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCLSLogIndexV3
<Common request parameters>
{
"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"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
| DryRunOperation | DryRun operation means the request will be successful, but the DryRun parameter is passed. |
| FailedOperation | Operation failed. |
| FailedOperation.DasbAmountNotEnough | FailedOperation.DasbAmountNotEnough |
| FailedOperation.DasbErrorCode | FailedOperation.DasbErrorCode |
| FailedOperation.DasbInvalidSecretId | FailedOperation.DasbInvalidSecretId |
| FailedOperation.DasbInvalidSecretKey | FailedOperation.DasbInvalidSecretKey |
| InternalError | Internal error. |
| InvalidFilter | Invalid Filter |
| InvalidParameter | Parameter error. |
| InvalidParameter.DecryptError | Decrypt error |
| InvalidParameter.ResourceId | InvalidParameter.ResourceId |
| InvalidParameterValue | Parameter value error. |
| InvalidParameterValue.SQLQueryFailed | SQL query failed |
| LimitExceeded | The quota limit is exceeded. |
| MissingParameter | Parameters are missing. |
| OperationDenied | Operation denied. |
| RegionError | Region error. |
| RequestLimitExceeded | Number of requests exceeds the frequency limit. |
| ResourceInUse | The resource is occupied. |
| ResourceInsufficient | Insufficient resources. |
| ResourceInsufficient.LogAnalysisQuantityInsufficient | Insufficient log analysis capacity |
| ResourceNotFound | The resource does not exist. |
| ResourceUnavailable | Resources are unavailable. |
| ResourcesSoldOut | Resources are sold out. |
| UnauthorizedOperation | Unauthorized operation. |
| UnauthorizedOperation.CloudAudit | Unauthorized operation on the "Operation Audit" product. |
| UnauthorizedOperation.Cos | Unauthorized operation on the "COS" product. |
| UnauthorizedOperation.NoPermission | UnauthorizedOperation.NoPermission |
| UnknownParameter | Unknown parameter error. |
| UnsupportedOperation | The operation is not supported. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback