AddExistedInstances

Last updated: 2019-09-09 11:45:44

PDF

1. API Description

API domain name: tke.tencentcloudapi.com.

This API adds one or more existing CVM instances to the specified cluster.

API request rate limit: 20 requests/sec.

Note: This API supports financial regions. As financial regions and non-financial regions are isolated, if a financial region,such as ap-shanghai-fsi, is assigned to the common parameter Region, we recommend you include that financial region in your domain name , such as tke.ap-shanghai-fsi.tencentcloudapi.com.

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 name of this API: AddExistedInstances
Version Yes String Common parameter. The version of this API: 2018-05-25
Region Yes String Common parameter. For more information, see the list of regions supported by the product.
ClusterId Yes String Cluster ID
InstanceIds.N Yes Array of String Instance list
InstanceAdvancedSettings No InstanceAdvancedSettings Additional parameters need to be specified for the CVM instance
EnhancedService No EnhancedService Enable or disable enhanced services, including Cloud Security, Cloud Monitoring. If this parameter is not specified, Cloud Monitoring and Cloud Security will be enabled by default
LoginSettings No LoginSettings Login to Node. Currently, you can only use password or a single KeyId to login to the node.
SecurityGroupIds.N No Array of String Security group of the instance. You may find this parameter in sgId returned by API DescribeSecurityGroups. If this parameter is not specified, the default security group is bound (currently, you can configure only one single sgId)

3. Output Parameters

Parameter Name Type Description
RequestId String Unique ID of the request. Each request returns a unique ID. The RequestId is required to troubleshoot issues.

4. Samples

Sample 1. Adding an Existing CVM Instance to a Cluster

Add an existing CVM instance to a cluster

Input Sample Code

https://tke.tencentcloudapi.com/?Action=AddExistedInstances
&ClusterId=cls-xxxxxx
&InstanceIds.0=ins-xxxxx
&<Common request parameters>

Output Sample Code

{
  "Response": {
    "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
  }
}

5. Resources for Developers

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

TencentCloud API 3.0 integrates software development toolkits (SDKs) that support various programming languages to make it easier for you to call the APIs.

Command line tools

6. Error Codes

The following error codes are API business logic-related. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error.
InternalError.Db Database error.
InternalError.DbAffectivedRows Database effective function error.
InternalError.Param Param.
InvalidParameter Invalid parameter.
LimitExceeded Quota limit is exceeded.