tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyLogKafkaAccess

Last updated: 2024-08-27 11:39:46

1. API Description

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

This API is used to add or modify the access configuration of logs shipped 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: ModifyLogKafkaAccess.
Version Yes String Common Params. The value used for this API: 2018-02-28.
Region No String Common Params. This parameter is not required.
KafkaEnvName Yes String Instance name, e.g. CWPP test environment
KafkaId Yes String Instance ID
AccessType Yes Integer Access method. 1 - public network domain name access; 2 - support environment access
AccessAddr Yes String Access address
Username Yes String Username
HasPwd Yes Integer 0 - without password; 1 - with password
DeliverTypeDetails.N Yes Array of DeliverTypeDetails Log shipping type configuration details
InsVersion Yes String Kafka version
Zone Yes String Region
Az Yes String Availability zone
VpcId Yes String vpcid address
SubnetId Yes String Subnet ID
DeliverStatus Yes Integer Shipping status. 1 - healthy; 2 - alarm; 3 - abnormal
BandWidth Yes Integer Peak bandwidth
DiskSize Yes Integer Disk capacity
Pwd No String Password, AES encryption

3. Output Parameters

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.

4. Example

Example1 Example

Input Example

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

{
    "Username": "a",
    "VpcId": "1.1.1.1",
    "Zone": "Guangzhou",
    "KafkaId": "aa",
    "InsVersion": "1.1.1",
    "AccessType": "1",
    "KafkaEnvName": "CWPP test environment",
    "BandWidth": "300",
    "AccessAddr": "1.1.1.1",
    "Pwd": "b",
    "DiskSize": "400",
    "SubnetId": "1.1.1.1",
    "DeliverTypeDetails": [
        {
            "Status": "0",
            "TopicId": "11",
            "SecurityType": "1",
            "LogType": [
                "1"
            ],
            "Switch": "0",
            "StatusTime": "11",
            "TopicName": "11",
            "ErrInfo": "1"
        }
    ],
    "Az": "Guangzhou Zone 3",
    "DeliverStatus": "1",
    "HasPwd": "1"
}

Output Example

{
    "Response": {
        "RequestId": "fee0ea18-d002-4af0-bee3-7f6efd19e357"
    }
}

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy