集群添加云主机
最近更新时间: 2026-10-11 00:12:05
1. 接口描述
接口请求域名： tsf.api3.fincloud.tencent.com。
添加云主机节点至TSF集群
默认接口请求频率限制：10000次/秒。
接口更新时间：2026-02-04 22:11:19。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：AddClusterInstances |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-03-26 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| InstanceIdList | 是 | 否 | Array of String | 云主机ID列表 示例值： ["ins-4zu6vmes","ins-4zu6vabe"] |
| OsName | 否 | 否 | String | 操作系统名称 示例值： centos 7.5 |
| ImageId | 否 | 否 | String | 操作系统镜像ID 示例值： img-4zu6vmes |
| Password | 否 | 否 | String | 重装系统密码设置 示例值： 4zu6xxxx |
| KeyId | 否 | 否 | String | 重装系统，关联密钥设置 示例值： skey-4zu6vmes |
| InstanceImportMode | 否 | 否 | String | 云主机导入方式，虚拟机集群必填，容器集群不填写此字段，R：重装TSF系统镜像，M：手动安装agent 示例值： R |
| OsCustomizeType | 否 | 否 | String | 镜像定制类型 示例值： DOCKER_CUSTOMIZE：表示容器定制版。 GENERAL：表示普通版本，默认值。 |
| FeatureIdList | 否 | 否 | Array of String | 镜像特征ID列表 示例值： ["feature-24aq56bg"] |
| ClusterId | 是 | 否 | String | 集群ID 示例值： cluster-4zu6vmes |
| SgId | 否 | 否 | String | 安全组设置 示例值： sg-4ae4pzgg |
| InstanceAdvancedSettings | 否 | 否 | InstanceAdvancedSettings | 实例额外需要设置参数信息 示例值：查看 |
| SecurityGroupIds | 否 | 否 | Array of String | 安全组 ID 列表 示例值： ["sg-4ae4pzgg", "sg-4ae4pzgh"] |
| InstanceCpuType | 否 | 否 | String | 实例cpu架构 示例值： x86 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | AddInstanceResult | 添加云主机的返回列表 示例值：查看 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| ResourceNotFound.ClusterNotExist | 无法获取命名空间所属集群。 |
| UnauthorizedOperation.CamTsfRoleNotExist | 当前主账号未创建TSF_QCSRole或未对子账号授予预设策略QcloudCamSubaccountsAuthorizeRoleFullAccess。请参考产品文档主账号协作者使用说明。。 |
| FailedOperation.InstanceResetError | 重装系统失败，请稍后重试。若无法解决，请联系智能客服或提交工单。 |
| FailedOperation.InstanceUpdateFailed | 机器实例更新失败。 |
| UnauthorizedOperation.NoPrivilege | 用户无权限访问该接口。。 |
| InternalError.CpClusterUnavailable | 容器平台集群不可用，当前状态 %s。 |
| FailedOperation.InstanceResetTimeout | 重装系统，请求超时。 |
| FailedOperation.TkeClusterQueryFailed | TKE 集群查询失败。 |
| InternalError.CloudApiProxyError | TSF云API请求调用失败。 |
| InternalError.TkeApiFailedOperation | 调用 TKE 接口失败，%s。 |
| InvalidParameterValue.InstanceInvalidImage | 重装系统，无效的镜像id。 |
| ResourceInUse.InstanceHasBeenUsed | 机器实例已经被使用。 |
| ResourceNotFound.InstanceNotExist | 无法获取机器信息。 |
| ResourceNotFound.TkeClusterNotExists | TKE 中不存在该集群。 |
| UnauthorizedOperation.CamGeneralError | 访问 CAM 系统出错，%s。 |
| FailedOperation.CloudApiProxyError | TSF云API请求调用失败。 |
| MissingParameter.ClusterIdRequired | 集群ID未填写。 |
5. 示例
示例1 添加云主机节点
输入示例
https://tsf.api3.fincloud.tencent.com/?Action=AddClusterInstances
&InstanceIdList.0=ins-xxxxxxx
&InstanceIdList.1=ins-xxxxxxx
&ClusterId=cluster-xxxxxxx
&InstanceImportMode=R
&ImageId=img-xxxxxxx
&Password=xxxxxxx
&<Common Parameters>
输出示例
{
"Response": {
"RequestId": "7b141f81-e708-46f0-a8d3-4e5259c82890",
"Result": {
"FailedInstanceIds": [
"ins-fgbrdsa12"
],
"SuccInstanceIds": [
"ins-geeqwysd1"
],
"TimeoutInstanceIds": [
"ins=kytrdqq45"
],
"FailedReasons": ["this is failed reason"]
}
}
}