tencent cloud



Last updated: 2022-08-23 15:21:29

1. API Description

Domain name for API request: cls.tencentcloudapi.com.

This API is used to create a collection rule configuration.

A maximum of 30 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: CreateConfig.
Version Yes String Common Params. The value used for this API: 2020-10-16.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
Name Yes String Collection configuration name
Output Yes String Log topic ID (TopicId) of collection configuration
Path No String Log collection path containing the filename
LogType No String Type of the log to be collected. Valid values: json_log: log in JSON format; delimiter_log: log in delimited format; minimalist_log: minimalist log; multiline_log: log in multi-line format; fullregex_log: log in full regex format. Default value: minimalist_log
ExtractRule No ExtractRuleInfo Extraction rule. If ExtractRule is set, LogType must be set.
ExcludePaths.N No Array of ExcludePathInfo Collection path blocklist
UserDefineRule No String Custom collection rule, which is a serialized JSON string

3. Output Parameters

Parameter Name Type Description
ConfigId String Collection configuration ID
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating collection rule configuration

Input Example

Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateConfig
<Common request parameters>

    "Name": "testname",
    "Path": "/data/nginx/log/**/access.log",
    "LogType": "delimiter_log",
    "ExtractRule": {
        "TimeKey": "date",
        "TimeFormat": "%Y-%m-%d %H:%M:%S",
        "Delimiter": "|",
        "LogRegex": ".*",
        "BeginRegex": "^",
        "Keys": [
        "FilterKeyRegex": [
                "Key": "xxx",
                "Regex": "ssss"
        "UnMatchLogKey": "testlog",
        "UnMatchUpLoadSwitch": true,
        "Backtracking": -1
    "ExcludePaths": [
            "Type": "xx",
            "Value": "xx"
    "Output": "xxxxxx-xxx-xxxxxx",
    "UserDefineRule": "xxxxxx"

Output Example

    "Response": {
        "ConfigId": "xxxx-xx-xx-xx-xxxxxxxx",
        "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"

5. Developer Resources


TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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.
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameter.ConfigConflict The same collection configuration rule already exists.
InvalidParameterValue Incorrect parameter value.
LimitExceeded.Config The collection rule configuration exceeds the maximum value 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.ConfigNotExist The specified collection rule configuration does not exist.
ResourceNotFound.TopicNotExist The log topic does not exist.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support