Release Notes
Announcements
Domain name for API request: cls.intl.tencentcloudapi.com.
This API is used to create an index.
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: CreateIndex. |
| 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 |
| Rule | Yes | RuleInfo | Index rule |
| Status | No | Boolean | Whether to take effect. Default value: true |
| IncludeInternalFields | No | Boolean | Whether full-text indexing includes internal fields (__FILENAME__, __HOSTNAME__, and __SOURCE__). Default value: false. Recommended value: true.* false: Full-text indexing does not include internal fields.* true: Full-text indexing includes internal fields. |
| MetadataFlag | No | Integer | Whether full-text indexing includes metadata fields (which are prefixed with __TAG__). Default value: 0. Recommended value: 1.* 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. |
| Parameter Name | Type | Description |
|---|---|---|
| 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: CreateIndex
<Common request parameters>
{
"TopicId": "3edc8551-111b-473b-9fc4-ed66e20dfa8a",
"Status": true,
"Rule": {
"FullText": {
"CaseSensitive": true,
"Tokenizer": "*"
},
"KeyValue": {
"CaseSensitive": true,
"KeyValues": [
{
"Key": "age",
"Value": {
"Type": "long",
"Tokenizer": "_",
"SqlFlag": false
}
}
]
},
"Tag": {
"CaseSensitive": true,
"KeyValues": [
{
"Key": "tag",
"Value": {
"Type": "string",
"Tokenizer": "**",
"SqlFlag": false
}
}
]
}
}
}{
"Response": {
"RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
}
}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.InValidIndexRuleForSearchLow | IA storage does not support key-value or tag index configuration. |
| FailedOperation.TopicIsolated | The log topic has been isolated. |
| InternalError | Internal error. |
| InvalidParameter | Incorrect parameter. |
| InvalidParameter.InValidIndexRuleForSearchLow | IA storage does not support key-value or tag index configuration. |
| InvalidParameter.IndexConflict | An index rule already exists for the specified log topic. |
| LimitExceeded | The quota limit has been reached. |
| LimitExceeded.IndexOperating | Index operations exceed the frequency limit. |
| MissingParameter | Missing parameter. |
| OperationDenied | Operation denied. |
| 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. |
| UnsupportedOperation | Unsupported operation. |
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