tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

EnableVpcCniNetworkType

Last updated: 2024-11-14 14:52:53

    1. API Description

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

    This API is used to enable the VPC-CNI network mode for GR clusters.

    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: EnableVpcCniNetworkType.
    Version Yes String Common Params. The value used for this API: 2018-05-25.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    ClusterId Yes String Cluster ID
    VpcCniType Yes String The VPC-CNI mode. tke-route-eni: Multi-IP ENI, tke-direct-eni: Independent ENI
    EnableStaticIp Yes Boolean Whether to enable static IP address
    Subnets.N Yes Array of String The container subnet being used
    ExpiredSeconds No Integer Specifies when to release the IP after the Pod termination in static IP mode. It must be longer than 300 seconds. If this parameter is left empty, the IP address will never be released.
    SkipAddingNonMasqueradeCIDRs No Boolean Whether to skip adding the VPC IP range to NonMasqueradeCIDRs field of ip-masq-agent-config. Default value: false

    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 Enabling VPC-CNI network mode

    This example shows you how to enable VPC-CNI network mode for a TKE cluster.

    Input Example

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

{
    "ClusterId": "cls-abcdefgh",
    "EnableStaticIp": false,
    "VpcCniType": "tke-route-eni",
    "Subnets": [
        "subnet-abcdefg1",
        "subnet-abcdefg2"
    ]
}

    Output Example

    {
    "Response": {
        "RequestId": "defc0237-d413-4079-9faa-7f3ff928d224"
    }
}

    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
    FailedOperation.EnableVPCCNIFailed Failed to enable the VPC-CNI mode.
    InternalError.UnexceptedInternal Internal error.
    InternalError.UnexpectedInternal Unknown internal error.
    InvalidParameter.Param Invalid parameter.
    UnsupportedOperation.ClusterNotSuitEnableVPCCNI The VPC-CNI mode is not supported.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy