用户指南

最佳实践

API 文档

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

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

最近更新时间:2021-05-21 08:08:18

我的收藏

1. 接口描述

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

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

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

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

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)
HostName String 重装系统时,可以指定修改实例的HostName(集群为HostName模式时,此参数必传,规则名称除不支持大写字符外与CVM创建实例接口HostName一致)
SecurityGroupIds.N Array of String 实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的sgId字段来获取。若不指定该参数,则绑定默认安全组。(目前仅支持设置单个sgId)
NodePool NodePoolOption 节点池选项
SkipValidateOptions.N Array of String 校验规则相关选项,可配置跳过某些校验规则。目前支持GlobalRouteCIDRCheck(跳过GlobalRouter的相关校验),VpcCniCIDRCheck(跳过VpcCni相关校验)
InstanceAdvancedSettingsOverrides.N Array of InstanceAdvancedSettings 参数InstanceAdvancedSettingsOverride数组用于定制化地配置各台instance,与InstanceIds顺序对应。当传入InstanceAdvancedSettingsOverrides数组时,将覆盖默认参数InstanceAdvancedSettings;当没有传入参数InstanceAdvancedSettingsOverrides时,InstanceAdvancedSettings参数对每台instance生效。

参数InstanceAdvancedSettingsOverride数组的长度应与InstanceIds数组一致;当长度大于InstanceIds数组长度时将报错;当长度小于InstanceIds数组时,没有对应配置的instace将使用默认配置。

3. 输出参数

参数名称 类型 描述
FailedInstanceIds Array of String 失败的节点ID
注意:此字段可能返回 null,表示取不到有效值。
SuccInstanceIds Array of String 成功的节点ID
注意:此字段可能返回 null,表示取不到有效值。
TimeoutInstanceIds Array of String 超时未返回出来节点的ID(可能失败,也可能成功)
注意:此字段可能返回 null,表示取不到有效值。
FailedReasons Array of String 失败的节点的失败原因
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

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

输入示例

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

输出示例

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

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InternalError.ClusterNotFound 集群未找到。
InternalError.ClusterState 集群状态错误。
InternalError.CvmCommon cvm创建节点报错。
InternalError.Db db错误。
InternalError.DbAffectivedRows DB错误。
InternalError.Param Param。
InternalError.UnexceptedInternal 内部错误。
InternalError.UnexpectedInternal 未知的内部错误。
InvalidParameter 参数错误。
LimitExceeded 超过配额限制。
目录