文档中心 容器服务 API 文档 集群相关接口 添加已经存在的实例到集群

添加已经存在的实例到集群

最近更新时间:2019-08-01 15:14:39

1. 接口描述

接口请求域名: tke.tencentcloudapi.com 。

添加已经存在的实例到集群

默认接口请求频率限制:20次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:tke.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:AddExistedInstances
Version String 公共参数,本接口取值:2018-05-25
Region String 公共参数,详见产品支持的 地域列表
ClusterId String 集群ID
InstanceIds.N Array of String 实例列表
InstanceAdvancedSettings InstanceAdvancedSettings 实例额外需要设置参数信息
EnhancedService EnhancedService 增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数,则默认开启云监控、云安全服务。
LoginSettings LoginSettings 节点登录信息(目前仅支持使用Password或者单个KeyIds)
SecurityGroupIds.N Array of String 实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的sgId字段来获取。若不指定该参数,则绑定默认安全组。(目前仅支持设置单个sgId)

3. 输出参数

参数名称 类型 描述
FailedInstanceIds Array of String 失败的节点ID
SuccInstanceIds Array of String 成功的节点ID
TimeoutInstanceIds Array of String 超时未返回出来节点的ID(可能失败,也可能成功)
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 添加已经存在的实例到集群

添加已经存在的实例到集群

输入示例

https://tke.tencentcloudapi.com/?Action=AddExistedInstances
&ClusterId=cls-xxxxxx
&InstanceIds.0=ins-xxxxx
&<公共请求参数>

输出示例

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

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误
InternalError.Db db错误。
InternalError.DbAffectivedRows DB影响函数错误。
InternalError.Param Param。
InvalidParameter 参数错误
LimitExceeded 超过配额限制