AddExistedInstances

Last updated: 2020-06-24 11:17:35

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.

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: AddExistedInstances.
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
InstanceIds.N Yes Array of String Instance list
InstanceAdvancedSettings No InstanceAdvancedSettings Additional parameter to be set for 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)
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)
HostName No String

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.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Adding Existing Instances to a Cluster

Adding Existing Instances to a Cluster

Input Example

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

Output Example

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

5. Developer Resources

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 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 Internal error
InternalError.Db DB error.
InternalError.DbAffectivedRows DB error
InternalError.Param Parameter error.
InvalidParameter Parameter error
LimitExceeded Quota limit exceeded

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help