移除云主机

最近更新时间: 2026-09-17 00:04:03

1. 接口描述

接口请求域名: tsf.api3.fincloud.tencent.cn。

从 TSF 集群中批量移除云主机节点

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

接口更新时间:2024-09-14 11:55:39。

接口既验签名又鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action String 公共参数,本接口取值:RemoveInstances
Version String 公共参数,本接口取值:2018-03-26
Region String 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表
ClusterId String 集群 ID
示例值:
InstanceIdList Array of String 云主机 ID 列表
示例值:

3. 输出参数

参数名称 类型 描述
Result Bool 集群移除机器是否成功
示例值:
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码 描述
ResourceNotFound.ClusterNotExist 无法获取命名空间所属集群。
UnauthorizedOperation.NoPrivilege 用户无权限访问该接口。。
InvalidParameterValue.CvmCaeMasterAgentBusy TSF MASTER 正在执行任务,请等待任务执行完成再下发新任务。
InternalError.TkeApiFailedOperation 调用 TKE 接口失败,%s。
ResourceNotFound.InstanceNotExist 无法获取机器信息。
FailedOperation.InstanceDeleteFailed 机器实例删除失败。

5. 示例

示例1 移除机器节点

输入示例

https://tsf.api3.<no value>/?Action=RemoveInstances
&ClusterId=cluster-xxxxxxx
&InstanceIdList.0=ins-xxxxxxxx
&InstanceIdList.1=ins-xxxxxxx
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "af6488bc-9ea0-43a6-b6ef-8815214b8b7f",
    "Result": true
  }
}