操作指南

API 文档

集群添加云主机

最近更新时间:2020-09-02 08:16:30

1. 接口描述

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

添加云主机节点至TSF集群

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:AddClusterInstances。
Version String 公共参数,本接口取值:2018-03-26。
Region String 公共参数,详见产品支持的 地域列表
ClusterId String 集群ID
InstanceIdList.N Array of String 云主机ID列表
OsName String 操作系统名称
ImageId String 操作系统镜像ID
Password String 重装系统密码设置
KeyId String 重装系统,关联密钥设置
SgId String 安全组设置
InstanceImportMode String 云主机导入方式,虚拟机集群必填,容器集群不填写此字段,R:重装TSF系统镜像,M:手动安装agent
OsCustomizeType String 镜像定制类型

3. 输出参数

参数名称 类型 描述
Result AddInstanceResult 添加云主机的返回列表
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 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 Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.InstanceResetError 重装系统,请求失败。
FailedOperation.InstanceUpdateFailed 机器实例更新失败。
UnauthorizedOperation.NoPrivilege 无访问权限。
目录