实例扩容

最近更新时间: 2026-07-12 00:25:32

1. 接口描述

接口请求域名： tbdsnew.api3.fincloud.tencent.com。

扩容一体化集群节点, 调用该接口, 需先参考TBDS提供的"TBDS5313集群部署手册"文档中初始化机器步骤对扩容节点进行初始化

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

接口更新时间：2025-09-19 15:38:35。

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：ScaleOutInstance
Version	是	否	String	公共参数，本接口取值：2019-01-03
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
ClientToken	否	否	String	客户端Token。示例值： 1
TimeUnit	是	否	String	固定值: s 示例值： s
TimeSpan	是	否	Int64	固定值: 3600 示例值： 3600
PreExecutedFileSettings	否	否	Array of PreExecuteFileSettings	引导操作脚本设置。示例值：查看
TaskCount	否	否	Int64	扩容的Task节点数量。示例值： 1
CoreCount	否	否	Int64	扩容的Core节点数量。示例值： 0
InstanceId	是	否	String	实例ID。示例值： tbds-gpigyari
PayMode	是	否	Int64	固定值: 0 示例值： 0
UnNecessaryNodeList	否	否	Array of Int64	扩容时不需要安装的进程。示例值： 1
RouterCount	否	否	Int64	扩容的Router节点数量。示例值： 0
SoftDeployInfo	否	否	Array of Int64	部署的服务。 SoftDeployInfo和ServiceNodeInfo是同组参数，和UnNecessaryNodeList参数互斥。建议使用SoftDeployInfo和ServiceNodeInfo组合。示例值： [2]
ServiceNodeInfo	否	否	Array of Int64	启动的进程。示例值： [7]
DisasterRecoverGroupIds	否	否	Array of String	分散置放群组ID列表，当前仅支持指定一个。示例值： []
Tags	否	否	Array of Tag	扩容节点绑定标签列表。示例值：查看
HardwareResourceType	否	否	String	扩容所选资源类型，可选范围为"host","pod"，host为普通的CVM资源，Pod为TKE集群或EKS集群提供的资源示例值： 1
PodSpec	否	否	PodSpec	使用Pod资源扩容时，指定的Pod规格以及来源等信息示例值：查看
ClickHouseClusterName	否	否	String	使用clickhouse集群扩容时，选择的机器分组名称示例值： 1
ClickHouseClusterType	否	否	String	使用clickhouse集群扩容时，选择的机器分组类型。new为新增，old为选择旧分组示例值： 1
YarnNodeLabel	否	否	String	规则扩容指定 yarn node label 示例值： 1
PodParameter	否	否	PodParameter	POD自定义权限和自定义参数示例值：查看
MasterCount	否	否	Int64	扩容的Master节点的数量。使用clickhouse集群扩容时，该参数不生效。使用kafka集群扩容时，该参数不生效。当HardwareResourceType=POD时，该参数不生效。示例值： 0
StartServiceAfterScaleOut	否	否	String	扩容后是否启动服务，true：启动，false：不启动示例值： false
ResourceStr	是	否	String	规格隐藏字段，示例：{"HostInfos":[{"IP":"10.0.0.68","Ipv6":"","Port":22,"status":"2","Arch":"x86_64","Username":"tbds","Password":"admintest@2023"}]} 示例值： {"hostInfos":[{"Ip":"10.206.16.113","HostName":"tnode34","Arch":"x86_64","UserName":"tbds","Password":"14a140c9e706b6de54e56175a87f9abd","Port":22}]}
ZoneId	否	否	Int64	可用区，默认是集群的主可用区示例值： 1
SubnetId	否	否	String	子网，默认是集群创建时的子网示例值：
ScaleOutServiceConfAssign	否	否	String	预设配置组示例值： {"YARN-3.2.2":-1}
ScaleOutOrIn	否	否	Int64	容器集群 0缩容 1扩容示例值： 1
AutoRenew	否	否	Int64	0表示关闭自动续费，1表示开启自动续费示例值： 1
TopoEnable	否	否	Bool	是否开启自定义topo 示例值： True
ServiceTopoInfos	否	否	CustomServiceTopoInfo	服务的自定义topo信息示例值：查看
ExtraInfo	否	否	String	扩容时的附加信息，map[string]string结构，使用字符串作为入参，扩容nn时，选择的NameService的key为nameService 示例值： 1

3. 输出参数

参数名称	类型	描述
InstanceId	String	实例ID。示例值： 1
DealNames	Array of String	订单号。（保留字段，当前版本暂未支持）注意：此字段可能返回 null，表示取不到有效值。示例值： 1
ClientToken	String	客户端Token。（保留字段，当前版本暂未支持）示例值： 1
FlowId	Int64	扩容流程ID。示例值： 1
BillId	String	大订单号。（保留字段，当前版本暂未支持）示例值： 1
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码	描述
InternalError.TKEError	TKE调用出错。
InvalidParameter.InvalidClickHouseCluster	无效的ClickHouse集群。
InternalError.TagError	内部服务调用异常。
FailedOperation.CheckIfSupportPodStretch	操作失败。
InternalError.ConfigCgwError	内部服务调用异常。
InternalError.EKSError	调用EKS报错。
InvalidParameter	参数错误。
ResourceInsufficient.InstanceInsufficient	不支持或售罄的节点规格。
InternalError.CamCgwError	内部服务调用异常。
InvalidParameter.InvalidClusterId	无效参数，ClusterId。
InvalidParameter.InvalidCountNum	同一请求只能扩容Task或者Core节点。
InvalidParameter.InvalidInstanceName	无效的集群名称。
FailedOperation.NotSupportPod	操作失败，不支持pod。
InternalError.ProjectCgwError	内部服务调用异常。
InternalError.TradeCgwError	内部服务调用异常。
InternalError.CdbError	内部服务调用异常。
InternalError.CvmError	内部服务调用异常。
ResourcesSoldOut.CvmSoldOut	云服务器已售罄。
ResourceNotFound.TKEPreconditionNotFound	tke集群前置组件未部署。
InvalidParameter.InvalidServiceNodeInfo	参数ServiceNodeInfo无效或错误。
InternalError.SgError	安全组接口调用异常。
InvalidParameter.InvalidTkeInstance	无效的Tke集群ID，或Tke集群不符合条件。
ResourceUnavailable.ResourceSpecNotDefaultSpec	当前资源规格不存在默认规格。
InternalError	内部错误。
ResourcesSoldOut.CbsSoldOut	CBS资源售罄。
InvalidParameter.AppIdResourceNotMatch	参数错误。
ResourceNotFound.TagsNotFound	没有查找到指定标签。
InvalidParameter.InvalidSercurityGrpupId	无效的安全组ID。
ResourceInsufficient.DiskInsufficient	硬盘规格不满足。
InvalidParameterValue.InvalidTkeInstance	无效的Tke集群ID，或Tke集群不符合条件。
InvalidParameter.InvalidEksInstance	无效的EKS实例。
InternalError.CdbCgwError	内部服务调用异常。
InvalidParameter.InvalidCount	扩容数量必须大于0。
InternalError.CbsCgwError	内部服务调用异常。
InternalError.CamError	内部服务调用异常。
InvalidParameter.InvalidPaymode	无效的付费类型。
InternalError.VpcError	内部服务调用异常。
FailedOperation	操作失败。
InvalidParameter.InvalidTimeSpan	无效的timespan。
InternalError.AccountCgwError	内部服务调用异常。
InvalidParameter.InvalidCustomizedPodParam	错误信息：Invalid PodParameter。
InternalError.CbsError	内部服务调用异常。
FailedOperation.DuplicateOrderNotAllowed	重复的订单，请检查emr控制台。
InternalError.VpcCgwError	内部服务调用异常。
ResourceNotFound.InstanceNotFound	无法找到该实例。
InvalidParameter.InvalidAppId	无效参数，AppId。
InvalidParameter.InvalidTimeUnit	无效的TimeUnit。
InvalidParameter.InvalidCoreCount	Core节点数量无效。
InternalError.WoodServerError	内部服务调用异常。
InvalidParameter.InvalidTaskCount	task的数量不能超过20。
ResourceNotFound.ClusterNotFound	无法找到该实例。
ResourceInUse.InstanceInProcess	实例在流程中。
ResourcesSoldOut	资源售罄。
InvalidParameter.InvalidResourceSpec	无效的资源规格。
InvalidParameter.InvalidSoftDeployInfo	参数InvalidSoftDeployInfo无效或错误。
InvalidParameter.InvalidClientToken	无效的ClientToken。
InternalError.KmsError	内部服务调用异常。