tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateLogConfig

Last updated: 2023-12-04 16:38:16

    1. API Description

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

    This API is used to create a log collecting configuration.

    A maximum of 20 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: CreateLogConfig.
    Version Yes String Common Params. The value used for this API: 2021-07-01.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    EnvironmentId Yes String Environment ID
    Name Yes String Configuration name
    InputType Yes String Collection type. Values: container_stdout (standard); container_file (file)
    ApplicationId No String Application ID
    LogsetId No String Logset ID
    TopicId No String Log topic ID
    LogType No String Log withdrawal mode. Values: minimalist_log (full text in a single line); multiline_log (full text in multiple lines); json_log (JSON); fullregex_log (regex in a single line); multiline_fullregex_log (regex in multiple lines)
    BeginningRegex No String The first line regex. It’s valid when LogType is multiline_log.
    LogPath No String Directory of files to collect. It’s valid when InputType is container_file.
    FilePattern No String Name pattern of files to collect. It’s valid when InputType is container_file.
    ExtractRule No LogConfigExtractRule Export

    3. Output Parameters

    Parameter Name Type Description
    Result Boolean Whether the creation is successful
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Creating log collecting configuration

    This example shows you how to create a log collecting configuration.

    Input Example

    POST / HTTP/1.1
Host: tem.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateLogConfig
<Common request parameters>

{
    "TopicId": "xx",
    "Name": "xx",
    "EnvironmentId": "xx",
    "LogPath": "xx",
    "InputType": "xx",
    "LogType": "xx",
    "FilePattern": "xx",
    "ApplicationId": "xx",
    "LogsetId": "xx",
    "ExtractRule": {
        "BeginningRegex": "xxx",
        "Keys": [
            "xxx"
        ]
    }
}

    Output Example

    {
    "Response": {
        "RequestId": "81f74023-563c-437d-abf7-8139449ef178",
        "Result": true
    }
}

    5. Developer Resources

    SDK

    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
    InternalError.CreateConfigDataError Failed to create the configuration.
    InternalError.CreateLogConfigError Error while creating the LogConfig.
    InternalError.DefaultInternalError The server is busy. Retry later.
    InvalidParameterValue.ConfigDataAlreadyExist This configuration already exists.
    InvalidParameterValue.LogConfigAlreadyExist The LogConfig already exists.
    InvalidParameterValue.NamespaceNotBelongToAppid The namespace does not belong to the current account.
    InvalidParameterValue.TemIdInvalid The TEM ID is incorrect.
    MissingParameter.NamespaceIdNull The environment ID can not be left empty.
    ResourceNotFound.VersionNamespaceNotFound The environment corresponding to this version is not found.
    UnauthorizedOperation.UnauthorizedOperation Not authorized
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy