개인 정보 보호 정책
데이터 처리 및 보안 계약
Domain name for API request: cls.intl.tencentcloudapi.com.
This API is used to get the index configuration 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: DescribeIndex. |
| Version | Yes | String | Common Params. The value used for this API: 2020-10-16. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| TopicId | Yes | String | Log topic ID |
| Parameter Name | Type | Description |
|---|---|---|
| TopicId | String | Log topic ID |
| Status | Boolean | Whether it takes effect |
| Rule | RuleInfo | Index configuration information Note: this field may return null, indicating that no valid values can be obtained. |
| ModifyTime | String | Index modification time. The default value is the index creation time. |
| IncludeInternalFields | Boolean | Whether full-text indexing includes internal fields (__FILENAME__, __HOSTNAME__, and __SOURCE__)* false: Full-text indexing does not include internal fields.* true: Full-text indexing includes internal fields.Note: This field may return null, indicating that no valid values can be obtained. |
| MetadataFlag | Integer | Whether full-text indexing includes metadata fields (which are prefixed with __TAG__)* 0: Full-text indexing includes only the metadata fields with key-value indexing enabled.* 1: Full-text indexing includes all metadata fields.* 2: Full-text indexing does not include metadata fields.Note: This field may return null, indicating that no valid values can be obtained. |
| 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: cls.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIndex
<Common request parameters>
{
"TopicId": "826f8b26-b054-4a0d-8c8e-f3d609f5e0ea"
}{
"Response": {
"TopicId": "826f8b26-b054-4a0d-8c8e-f3d609f5e0ea",
"Status": true,
"Rule": {
"FullText": {
"CaseSensitive": false,
"Tokenizer": "-=/?"
},
"KeyValue": {
"CaseSensitive": false,
"KeyValues": [
{
"Key": "age",
"Value": {
"Type": "long",
"SqlFlag": true
}
}
]
},
"Tag": {
"CaseSensitive": false,
"KeyValues": [
{
"Key": "__TAG__.timestamp",
"Value": {
"Type": "long",
"SqlFlag": true
}
}
]
}
},
"ModifyTime": "2021-01-13 21:00:08",
"RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7",
"IncludeInternalFields": true,
"MetadataFlag": 1
}
}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 |
|---|---|
| FailedOperation | Operation failed. |
| FailedOperation.TopicIsolated | The log topic has been isolated. |
| InternalError | Internal error. |
| InvalidParameter | Incorrect parameter. |
| MissingParameter | Missing parameter. |
| OperationDenied | Operation denied. |
| OperationDenied.ACLFailed | ACL verification failed. |
| OperationDenied.AccountDestroy | The account has been terminated. |
| OperationDenied.AccountIsolate | The account has overdue payments. |
| OperationDenied.AccountNotExists | The account does not exist. |
| ResourceNotFound.IndexNotExist | The index does not exist. |
| ResourceNotFound.TopicNotExist | The log topic does not exist. |
피드백