tencent cloud

文档反馈

CreateClusterInstances

最后更新时间:2023-09-18 16:00:21

1. API Description

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

This API is used to create one or more nodes in a cluster.

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: CreateClusterInstances.
Version Yes String Common Params. The value used for this API: 2018-05-25.
Region No String Common Params. This parameter is not required for this API.
ClusterId Yes String Cluster ID. Enter the ClusterId field returned by the DescribeClusters API
RunInstancePara Yes String Pass-through parameter for CVM creation in the format of a JSON string. To ensure the idempotence of requests for adding cluster nodes, you need to add the ClientToken field in this parameter. For more information, see the documentation for RunInstances API.
InstanceAdvancedSettings No InstanceAdvancedSettings Additional parameter to be set for the instance
SkipValidateOptions.N No Array of String Skips the specified verification. Valid values: GlobalRouteCIDRCheck, VpcCniCIDRCheck

3. Output Parameters

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

4. Example

Example1 Adding nodes to a cluster

Input Example

https://tke.tencentcloudapi.com/?Action=CreateClusterInstances
&ClusterId=cls-xxxxxxxx
&RunInstancePara={"Placement":{"Zone":"ap-guangzhou-4"},"InstanceType":"S3.SMALL1"}
&<Common request parameters>

Output Example

{
    "Response": {
        "InstanceIdSet": [
            "ins-xxxxxxxx"
        ],
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
    }
}

Example2 Adding cluster nodes (multiple data disks)

This example shows you how to add a node with multiple data disks to a cluster.

  1. Set DataDisks in InstanceAdvancedSettings to set the mounting information for multiple data disks. The backend will match data disks with data disk IDs based on their types and sizes and mount them to the corresponding paths.
  2. Set DataDisks in RunInstancePara. This parameter will be passed through to the CVM to indicate the purchase of multiple data disks.
  3. MountTarget in InstanceAdvancedSettings is disused.

Input Example

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

{
    "InstanceAdvancedSettings": {
        "DataDisks": [
            {
                "AutoFormatAndMount": true,
                "DiskSize": 50,
                "DiskType": "CLOUD_PREMIUM",
                "FileSystem": "ext4",
                "MountTarget": "/data2"
            },
            {
                "AutoFormatAndMount": true,
                "DiskSize": 120,
                "DiskType": "CLOUD_PREMIUM",
                "FileSystem": "ext4",
                "MountTarget": "/data4"
            },
            {
                "AutoFormatAndMount": true,
                "DiskSize": 100,
                "DiskType": "CLOUD_PREMIUM",
                "FileSystem": "ext4",
                "MountTarget": "/data3"
            },
            {
                "AutoFormatAndMount": true,
                "DiskSize": 50,
                "DiskType": "CLOUD_PREMIUM",
                "FileSystem": "ext4",
                "MountTarget": "/data5"
            }
        ],
        "DockerGraphPath": "/var/lib/docker",
        "MountTarget": "/var/lib/docker",
        "Unschedulable": 0,
        "UserScript": ""
    },
    "SkipValidateOptions": [
        "GlobalRouteCIDRCheck",
        "VpcCniCIDRCheck"
    ],
    "RunInstancePara": "xx",
    "ClusterId": "cls-xxxxx"
}

Output Example

{
    "Response": {
        "InstanceIdSet": [
            "ins-xxxxxxxx"
        ],
        "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.

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 Operation failed.
FailedOperation.AccountCommon Failed to obtain user authentication information.
FailedOperation.ClusterNotFound The cluster is not found.
FailedOperation.ClusterState Cluster status error.
FailedOperation.CvmCommon Failed to create the node due to a CVM error
FailedOperation.Db Database error.
FailedOperation.NetworkScaleError Network extension error.
FailedOperation.Param Invalid parameter.
FailedOperation.QuotaMaxNodLimit Reached the quota limit.
InternalError Internal error.
InternalError.AccountCommon Failed to obtain the user authentication information
InternalError.AccountUserNotAuthenticated Account not verified.
InternalError.ClusterNotFound Cluster not found.
InternalError.ClusterState Cluster status error.
InternalError.ComponentClinetHttp Error while requesting (HTTP) other Tencent Cloud services
InternalError.CvmCommon Error in node creation.
InternalError.CvmNotFound CVM does not exist.
InternalError.Db DB error.
InternalError.DbAffectivedRows Database error.
InternalError.DbRecordNotFound Record not found.
InternalError.ImageIdNotFound Image not found.
InternalError.OsNotSupport Image OS not supported.
InternalError.Param Parameter error.
InternalError.QuotaMaxClsLimit Quota limit exceeded.
InternalError.QuotaMaxNodLimit Quota limit exceeded.
InternalError.QuotaMaxRtLimit Quota limit exceeded.
InternalError.UnexceptedInternal Internal error.
InternalError.UnexpectedInternal Unknown internal error.
InternalError.VpcCommon VPC error
InternalError.VpcPeerNotFound Peering connection does not exist
InternalError.VpcRecodrNotFound VPC record not found
InvalidParameter Parameter error.
MissingParameter Missing parameter.
ResourceInUse The resource is occupied.
ResourceInsufficient.SpecifiedInstanceType Insufficient CVM resources.
ResourceNotFound The resource does not exist.
ResourceUnavailable Resource is unavailable
UnauthorizedOperation Unauthorized operation.
UnknownParameter Unknown parameter.
UnsupportedOperation Unsupported operation.
联系我们

联系我们,为您的业务提供专属服务。

技术支持

如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

7x24 电话支持