AddClusterInstances
最近更新时间: 2025-10-20 17:06:16
1. 接口描述
接口请求域名: tsf.api3.fincloud.tencent.cn。
添加云主机节点至TSF集群
默认接口请求频率限制:20次/秒。
接口更新时间:2022-01-06 19:36:38。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:AddClusterInstances |
| Version | 是 | 否 | String | 公共参数,本接口取值:2018-03-26 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| ClusterId | 是 | 否 | String | 集群ID |
| InstanceIdList | 是 | 否 | Array of String | 云主机ID列表 |
| OsName | 否 | 否 | String | 操作系统名称 |
| ImageId | 否 | 否 | String | 操作系统镜像ID |
| Password | 否 | 否 | String | 重装系统密码设置 |
| KeyId | 否 | 否 | String | 重装系统,关联密钥设置 |
| SgId | 否 | 否 | String | 安全组设置 |
| InstanceImportMode | 否 | 否 | String | 云主机导入方式,虚拟机集群必填,容器集群不填写此字段,R:重装TSF系统镜像,M:手动安装agent |
| OsCustomizeType | 否 | 否 | String | 镜像定制类型 |
| FeatureIdList | 否 | 否 | Array of String | 镜像特征ID列表 |
| InstanceAdvancedSettings | 否 | 否 | InstanceAdvancedSettings | 实例额外需要设置参数信息 |
| SecurityGroupIds | 否 | 否 | Array of String | 部署组ID |
| InstanceCpuType | 否 | 否 | String | 实例cpu架构 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | AddInstanceResult | 此参数对外不可见。 添加云主机的返回列表 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| ResourceNotFound.ClusterNotExist | 无法获取命名空间所属集群。 |
| FailedOperation.InstanceResetError | 重装系统失败,请稍后重试。若无法解决,请联系智能客服或提交工单。 |
| FailedOperation.InstanceUpdateFailed | 机器实例更新失败。 |
| UnauthorizedOperation.NoPrivilege | 用户无权限访问该接口。。 |
| InternalError.CpClusterUnavailable | 容器平台集群不可用,当前状态 %s。 |
| FailedOperation.InstanceResetTimeout | 重装系统,请求超时。 |
| FailedOperation.TkeClusterQueryFailed | TKE 集群查询失败。 |
| InternalError.CloudApiProxyError | TSF云API请求调用失败。 |
| InternalError.TkeApiFailedOperation | 调用 TKE 接口失败,%s。 |
| ResourceInUse.InstanceHasBeenUsed | 机器实例已经被使用。 |
| ResourceNotFound.InstanceNotExist | 无法获取机器信息。 |
| ResourceNotFound.TkeClusterNotExists | TKE 中不存在该集群。 |
| UnauthorizedOperation.CamGeneralError | 访问 CAM 系统出错,%s。 |