tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

AddExistedInstances

Last updated: 2024-11-14 14:50:10

    1. API Description

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

    This API is used to add one or more existing instances to 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: AddExistedInstances.
    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
    InstanceIds.N Yes Array of String Instance list. Spot instance is not supported.
    InstanceAdvancedSettings No InstanceAdvancedSettings Detailed information of the instance
    EnhancedService No EnhancedService Enhanced services. This parameter is used to specify whether to enable Cloud Security, Cloud Monitoring and other services. If this parameter is not specified, Cloud Monitor and Cloud Security are enabled by default.
    LoginSettings No LoginSettings Node login information (currently only supports using Password or single KeyIds)
    HostName No String When reinstalling the system, you can specify the HostName of the modified instance (when the cluster is in HostName mode, this parameter is required, and the rule name is the same as the Create CVM Instance API HostName except for uppercase letters not being supported.
    SecurityGroupIds.N No Array of String Security group to which the instance belongs. This parameter can be obtained from the sgId field returned by DescribeSecurityGroups. If this parameter is not specified, the default security group is bound. (Currently, you can only set a single sgId)
    NodePool No NodePoolOption Node pool options
    SkipValidateOptions.N No Array of String Skips the specified verification. Valid values: GlobalRouteCIDRCheck, VpcCniCIDRCheck
    InstanceAdvancedSettingsOverrides.N No Array of InstanceAdvancedSettings This API is used to customize the configuration of an instance, which corresponds to the "InstanceIds" one-to-one in sequence. If the InstanceAdvancedSettingsOverrides array is passed in, the default parameter "InstanceAdvancedSettings" will be overwritten. If the parameter InstanceAdvancedSettingsOverrides is not passed in, the parameter "InstanceAdvancedSettings" will take effect for each instance. The array length of "InstanceAdvancedSettingsOverride" should be the same as the array length of "InstanceIds". If its array length is greater than the "InstanceIds" array length, an error will be reported. If its array length is less than the "InstanceIds" array length, the instance without corresponding configuration will use the default configuration.
    ImageId No String Node image

    3. Output Parameters

    Parameter Name Type Description
    FailedInstanceIds Array of String IDs of failed nodes
    Note: This field may return null, indicating that no valid value was found.
    SuccInstanceIds Array of String IDs of successful nodes
    Note: This field may return null, indicating that no valid value was found.
    TimeoutInstanceIds Array of String IDs of (successful or failed) nodes that timed out
    Note: This field may return null, indicating that no valid value was found.
    FailedReasons Array of String Causes of the failure to add a node to a cluster
    Note: this field may return null, indicating that no valid value is obtained.
    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 Adding existing instances to a cluster

    This example shows you how to add existing instances to a cluster.

    Input Example

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

{
    "ClusterId": "cls-xxxxxx",
    "InstanceIds": [
        "ins-xxxxx"
    ]
}

    Output Example

    {
    "Response": {
        "TimeoutInstanceIds": [
            "ins-lqdahrp3"
        ],
        "SuccInstanceIds": [
            "ins-lqdahrp4"
        ],
        "FailedInstanceIds": [
            "ins-lqdahrp5"
        ],
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397",
        "FailedReasons": [
            "InstanceId ins-lqdahrp5 ServiceResetCvmV3 failed ..."
        ]
    }
}

    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.ClusterNotFound The cluster is not found.
    FailedOperation.ClusterState Cluster status error.
    FailedOperation.ComponentClientHttp Internal HTTP client error.
    FailedOperation.CvmCommon Failed to create the node due to a CVM error
    FailedOperation.NetworkScaleError Network extension error.
    FailedOperation.NodeExistsSecondaryNetworkInterface The node has a secondary ENI.
    FailedOperation.Param Invalid parameter.
    FailedOperation.QuotaMaxNodLimit Reached the quota limit.
    InternalError Internal error.
    InternalError.ClusterNotFound Cluster not found.
    InternalError.ClusterState Cluster status error.
    InternalError.CvmCommon Error in node creation.
    InternalError.Db DB error.
    InternalError.DbAffectivedRows Database error.
    InternalError.Param Parameter error.
    InternalError.QuotaMaxNodLimit Quota limit exceeded.
    InternalError.UnexceptedInternal Internal error.
    InternalError.UnexpectedInternal Unknown internal error.
    InvalidParameter Parameter error.
    InvalidParameter.VersionNotSupportCgroupV2 In customer creation parameters, k8s version, runtime version, or tke-eni-agent version do not support the chosen operating system's CgroupV2.
    LimitExceeded Quota limit is exceeded.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy