tencent cloud

1. API Description

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

This API is used to create a cluster.

A maximum of 20 requests can be initiated per second for this API.

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.

3. Output Parameters

4. Example

Example1 Creating a managed cluster

This example shows you how to create a managed cluster.

Input Example

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

{
    "ClusterCIDRSettings": {
        "ServiceCIDR": "xx",
        "ClaimExpiredSeconds": 0,
        "MaxClusterServiceNum": 1,
        "MaxNodePodNum": 1,
        "EniSubnetIds": [
            "xx"
        ],
        "ClusterCIDR": "xx",
        "IgnoreServiceCIDRConflict": true,
        "IgnoreClusterCIDRConflict": true
    },
    "ClusterAdvancedSettings": {
        "AuditEnabled": true,
        "DeletionProtection": true,
        "RuntimeVersion": "xx",
        "IsDualStack": true,
        "IsNonStaticIpMode": true,
        "KubeProxyMode": "xx",
        "AuditLogTopicId": "xx",
        "ExtraArgs": {
            "KubeAPIServer": [
                "xx"
            ],
            "KubeScheduler": [
                "xx"
            ],
            "KubeControllerManager": [
                "xx"
            ],
            "Etcd": [
                "xx"
            ]
        },
        "AuditLogsetId": "xx",
        "EnableCustomizedPodCIDR": true,
        "CiliumMode": "xx",
        "AsEnabled": true,
        "ContainerRuntime": "xx",
        "VpcCniType": "xx",
        "NetworkType": "xx",
        "NodeNameType": "xx",
        "IPVS": true,
        "BasePodNumber": 0
    },
    "ClusterBasicSettings": {
        "AutoUpgradeClusterLevel": {
            "IsAutoUpgrade": true
        },
        "VpcId": "xx",
        "ClusterVersion": "xx",
        "TagSpecification": [
            {
                "ResourceType": "xx",
                "Tags": [
                    {
                        "Value": "xx",
                        "Key": "xx"
                    }
                ]
            }
        ],
        "ClusterName": "xx",
        "ProjectId": 0,
        "ClusterDescription": "xx",
        "NeedWorkSecurityGroup": true,
        "SubnetId": "xx",
        "OsCustomizeType": "xx",
        "ClusterLevel": "xx",
        "ClusterOs": "xx"
    },
    "RunInstancesForNode": [
        {
            "InstanceAdvancedSettingsOverrides": [
                {
                    "PreStartUserScript": "xx",
                    "DockerGraphPath": "xx",
                    "Labels": [
                        {
                            "Name": "xx",
                            "Value": "xx"
                        }
                    ],
                    "ExtraArgs": {
                        "Kubelet": [
                            "xx"
                        ]
                    },
                    "Taints": [
                        {
                            "Value": "xx",
                            "Key": "xx",
                            "Effect": "xx"
                        }
                    ],
                    "Unschedulable": 0,
                    "UserScript": "xx",
                    "DesiredPodNumber": 0,
                    "GPUArgs": {
                        "MIGEnable": true,
                        "CustomDriver": {
                            "Address": "xx"
                        },
                        "Driver": {
                            "Version": "xx",
                            "Name": "xx"
                        },
                        "CUDA": {
                            "Version": "xx",
                            "Name": "xx"
                        },
                        "CUDNN": {
                            "DocName": "xx",
                            "Version": "xx",
                            "Name": "xx",
                            "DevName": "xx"
                        }
                    },
                    "MountTarget": "xx",
                    "DataDisks": [
                        {
                            "DiskPartition": "xx",
                            "DiskType": "xx",
                            "DiskSize": 0,
                            "FileSystem": "xx",
                            "AutoFormatAndMount": true,
                            "MountTarget": "xx"
                        }
                    ]
                }
            ],
            "NodeRole": "xx",
            "RunInstancesPara": [
                "{\"VirtualPrivateCloud\":{\"SubnetId\":\"subnet-xxx\",\"VpcId\":\"vpc-xxx\"},\"Placement\":{\"Zone\":\"ap-region-1\",\"ProjectId\":1032509},\"InstanceType\":\"S3.LARGE8\",\"SystemDisk\":{\"DiskType\":\"CLOUD_PREMIUM\"},\"DataDisks\":[{\"DiskType\":\"CLOUD_PREMIUM\",\"DiskSize\":50}],\"InstanceCount\":1,\"InternetAccessible\":{\"PublicIpAssigned\":true,\"InternetMaxBandwidthOut\":1},\"LoginSettings\":{\"Password\":\"YourPassword\"},\"UserData\":\"IyEvYmluL3NoCgplY2hvIGFhYQo=\"}"
            ]
        }
    ],
    "ExtensionAddons": [
        {
            "AddonName": "xx",
            "AddonParam": "xx"
        }
    ],
    "ClusterType": "xx",
    "InstanceAdvancedSettings": {
        "PreStartUserScript": "xx",
        "DockerGraphPath": "xx",
        "Labels": [
            {
                "Name": "xx",
                "Value": "xx"
            }
        ],
        "ExtraArgs": {
            "Kubelet": [
                "xx"
            ]
        },
        "Taints": [
            {
                "Value": "xx",
                "Key": "xx",
                "Effect": "xx"
            }
        ],
        "Unschedulable": 0,
        "UserScript": "xx",
        "DesiredPodNumber": 0,
        "GPUArgs": {
            "MIGEnable": true,
            "CustomDriver": {
                "Address": "xx"
            },
            "Driver": {
                "Version": "xx",
                "Name": "xx"
            },
            "CUDNN": {
                "DocName": "xx",
                "Version": "xx",
                "Name": "xx",
                "DevName": "xx"
            }
        },
        "MountTarget": "xx",
        "DataDisks": [
            {
                "DiskPartition": "xx",
                "DiskType": "xx",
                "DiskSize": 0,
                "FileSystem": "xx",
                "AutoFormatAndMount": true,
                "MountTarget": "xx"
            }
        ]
    },
    "ExistedInstancesForNode": [
        {
            "ExistedInstancesPara": {
                "InstanceAdvancedSettings": {
                    "PreStartUserScript": "xx",
                    "DockerGraphPath": "xx",
                    "Labels": [
                        {
                            "Name": "xx",
                            "Value": "xx"
                        }
                    ],
                    "ExtraArgs": {
                        "Kubelet": [
                            "xx"
                        ]
                    },
                    "Taints": [
                        {
                            "Value": "xx",
                            "Key": "xx",
                            "Effect": "xx"
                        }
                    ],
                    "Unschedulable": 0,
                    "UserScript": "xx",
                    "DesiredPodNumber": 0,
                    "GPUArgs": {
                        "MIGEnable": true,
                        "CustomDriver": {
                            "Address": "xx"
                        },
                        "CUDNN": {
                            "DocName": "xx",
                            "Version": "xx",
                            "Name": "xx",
                            "DevName": "xx"
                        }
                    },
                    "MountTarget": "xx",
                    "DataDisks": [
                        {
                            "DiskPartition": "xx",
                            "DiskType": "xx",
                            "DiskSize": 0,
                            "FileSystem": "xx",
                            "AutoFormatAndMount": true,
                            "MountTarget": "xx"
                        }
                    ]
                },
                "HostName": "xx",
                "LoginSettings": {
                    "Password": "xx",
                    "KeepImageLogin": "xx",
                    "KeyIds": [
                        "xx"
                    ]
                },
                "SecurityGroupIds": [
                    "xx"
                ],
                "EnhancedService": {
                    "SecurityService": {
                        "Enabled": true
                    },
                    "MonitorService": {
                        "Enabled": true
                    },
                    "AutomationService": {
                        "Enabled": true
                    }
                },
                "InstanceIds": [
                    "xx"
                ]
            },
            "DesiredPodNumbers": [
                0
            ],
            "NodeRole": "xx"
        }
    ],
    "InstanceDataDiskMountSettings": [
        {
            "InstanceType": "xx",
            "Zone": "xx",
            "DataDisks": [
                {
                    "DiskPartition": "xx",
                    "DiskType": "xx",
                    "DiskSize": 0,
                    "FileSystem": "xx",
                    "AutoFormatAndMount": true,
                    "MountTarget": "xx"
                }
            ]
        }
    ]
}

Output Example

{
    "Response": {
        "ClusterId": "cls-xxx",
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
    }
}

Example2 Creating a self-deployed cluster

This example shows you how to create a self-deployed cluster.

Input Example

https://tke.tencentcloudapi.com/?Action=CreateCluster
&ClusterType=INDEPENDENT_CLUSTER
&ClusterCIDRSettings.ClusterCIDR=10.4.0.0/14
&RunInstancesForNode.0.NodeRole=MASTER_ETCD
&RunInstancesForNode.0.RunInstancesPara.0={"VirtualPrivateCloud":{"SubnetId":"subnet-xxx","VpcId":"vpc-xxx"},"Placement":{"Zone":"ap-region-1","ProjectId":1032509},"InstanceType":"S3.LARGE8","SystemDisk":{"DiskType":"CLOUD_PREMIUM"},"DataDisks":[{"DiskType":"CLOUD_PREMIUM","DiskSize":50}],"InstanceCount":3,"InternetAccessible":{"PublicIpAssigned":true,"InternetMaxBandwidthOut":1},"LoginSettings":{"Password":"YourPassword"},"UserData":"IyEvYmluL3NoCgplY2hvIGFhYQo="}
&RunInstancesForNode.1.NodeRole=WORKER
&RunInstancesForNode.1.RunInstancesPara.0={"VirtualPrivateCloud":{"SubnetId":"subnet-xxx","VpcId":"vpc-xxx"},"Placement":{"Zone":"ap-region-1","ProjectId":1032509},"InstanceType":"S3.LARGE8","SystemDisk":{"DiskType":"CLOUD_PREMIUM"},"DataDisks":[{"DiskType":"CLOUD_PREMIUM","DiskSize":50}],"InstanceCount":1,"InternetAccessible":{"PublicIpAssigned":true,"InternetMaxBandwidthOut":1},"LoginSettings":{"Password":"YourPassword"},"UserData":"IyEvYmluL3NoCgplY2hvIGFhYQo="}
&ExtensionAddons.0.AddonName=GameApp
&ExtensionAddons.0.AddonParam={"kind":"GameApp","apiVersion":"platform.tke/v1","metadata":{"generateName":"ga"},"spec":{"clusterName":"xxx"}}
&<Common request parameters>

Output Example

{
    "Response": {
        "ClusterId": "cls-xxx",
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for Node.js
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++

Command Line Interface

• Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.