tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifySecLogDeliveryKafkaSetting

Last updated: 2023-12-04 17:11:20

    1. API Description

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

    This API is used to update the settings of security log delivery to Kafka.

    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: ModifySecLogDeliveryKafkaSetting.
    Version Yes String Common Params. The value used for this API: 2020-11-01.
    Region No String Common Params. This parameter is not required.
    InstanceID No String Instance ID
    InstanceName No String Instance name
    Domain No String Domain
    User No String Username
    Password No String Password
    LogTypeList.N No Array of SecLogDeliveryKafkaSettingInfo List of log types
    AccessType No Integer Access type
    KafkaVersion No String Kafka version number
    RegionID No String Region ID

    3. Output Parameters

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

    4. Example

    Example1 Updating the Kafka settings for security log shipping

    Input Example

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

{
    "InstanceID": "Instance ID",
    "InstanceName": "Instance name",
    "Domain": "Domain",
    "User": "Username",
    "Password": "Password",
    "RegionID": "xxx",
    "LogTypeList": [
        {
            "LogType": "container_bash",
            "TopicID": "Topic ID",
            "TopicName": "Topic name",
            "State": true
        }
    ]
}

    Output Example

    {
    "Response": {
        "RequestId": "29b37d86-f63d-43d1-b21a-640e82965198"
    }
}

    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 An internal error occurred.
    InvalidParameter The parameter is incorrect.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy