Last updated: 2021-08-03 10:32:22

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.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: tke.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: EnableVpcCniNetworkType.
Version Yes String Common parameter. The value used for this API: 2018-05-25.
Region Yes String Common parameter. 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.

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

Input Example

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

    "ClusterId": "xx",
    "EnableStaticIp": false,
    "VpcCniType": "tke-route-eni",
    "Subnets": [

Output Example

  "Response": {
    "RequestId": "xx"

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
InternalError.UnexceptedInternal Internal error.
InternalError.UnexpectedInternal Unknown internal error.