微服务平台 TSF 集群添加云主机-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： tsf.tencentcloudapi.com 。

添加云主机节点至TSF集群

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：AddClusterInstances。
Version	是	String	公共参数，本接口取值：2018-03-26。
Region	是	String	公共参数，详见产品支持的地域列表。
ClusterId	是	String	集群ID 示例值：cluster-xxxxxxx
InstanceIdList.N	是	Array of String	云主机ID列表示例值：["ins-xxxxxxx\n","ins-xxxxxxx\n"]
OsName	否	String	操作系统名称
ImageId	否	String	操作系统镜像ID 示例值：img-xxxxxxx
Password	否	String	重装系统密码设置示例值：xxxxxxx
KeyId	否	String	重装系统，关联密钥设置
SgId	否	String	安全组设置
InstanceImportMode	否	String	云主机导入方式，虚拟机集群必填，容器集群不填写此字段，R：重装TSF系统镜像，M：手动安装agent 示例值：R
OsCustomizeType	否	String	镜像定制类型
FeatureIdList.N	否	Array of String	镜像特征ID列表
InstanceAdvancedSettings	否	InstanceAdvancedSettings	实例额外需要设置参数信息
SecurityGroupIds.N	否	Array of String	安全组 ID 列表

3. 输出参数

参数名称	类型	描述
Result	AddInstanceResult	添加云主机的返回列表注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 添加云主机节点

输入示例

https://tsf.tencentcloudapi.com/?Action=AddClusterInstances
&InstanceIdList.0=ins-xxxxxxx
&InstanceIdList.1=ins-xxxxxxx
&ClusterId=cluster-xxxxxxx
&InstanceImportMode=R
&ImageId=img-xxxxxxx
&Password=xxxxxxx
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "7b141f81-e708-46f0-a8d3-4e5259c82890",
        "Result": {
            "FailedInstanceIds": [
                "ins-fgbrdsa12"
            ],
            "SuccInstanceIds": [
                "ins-geeqwysd1"
            ],
            "TimeoutInstanceIds": [
                "ins=kytrdqq45"
            ]
        }
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.CloudApiProxyError	TSF云API请求调用失败。
FailedOperation.InstanceResetError	重装系统失败，请稍后重试。若无法解决，请联系智能客服或提交工单。
FailedOperation.InstanceResetTimeout	重装系统，请求超时。
FailedOperation.InstanceUpdateFailed	机器实例更新失败。
FailedOperation.TkeClusterQueryFailed	TKE 集群查询失败。
InternalError.CloudApiProxyError	TSF云API请求调用失败。
InternalError.CpClusterUnavailable	容器平台集群不可用，当前状态 %s。
InternalError.TkeApiFailedOperation	调用 TKE 接口失败，%s。
InvalidParameterValue.InstanceInvalidImage	重装系统，无效的镜像id。
ResourceInUse.InstanceHasBeenUsed	机器实例已经被使用。
ResourceNotFound.ClusterNotExist	无法获取命名空间所属集群。
ResourceNotFound.InstanceNotExist	无法获取机器信息。
ResourceNotFound.TkeClusterNotExists	TKE 中不存在该集群。
UnauthorizedOperation.CamGeneralError	访问 CAM 系统出错，%s。
UnauthorizedOperation.CamTsfRoleNotExist	当前主账号未创建TSF_QCSRole或未对子账号授予预设策略QcloudCamSubaccountsAuthorizeRoleFullAccess。请参考产品文档主账号协作者使用说明。。
UnauthorizedOperation.NoPrivilege	用户无权限访问该接口。。

集群添加云主机

本页目录：