Skip to Content
分布式NewSQL数据库 TiDB创建预付费实例 - CreateTiDBClusterService

创建预付费实例 - CreateTiDBClusterService

简介

创建预付费实例

定义

公共参数

参数名类型描述信息必填
Actionstring对应的 API 指令名称,当前 API 为 CreateTiDBClusterServiceYes
PublicKeystring用户公钥,可从 控制台 获取Yes
Signaturestring根据公钥及 API 指令生成的用户签名,参见 签名算法Yes

请求参数

参数名类型描述信息必填
Regionstring地域。 参见 地域和可用区列表Yes
Zonestring可用区。参见 可用区列表Yes
ProjectIdstring项目ID。不填写为默认项目,子帐号必须填写。 请参考GetProjectList接口No
Namestring集群名称Yes
Passwordstring集群密码Yes
VPCIdstringVPC idYes
SubnetIdstring子网IDYes
PubUlbIdstring公网Ulb IDYes
DTTypestring容灾类型:10:同可用区,20:跨可用区,默认是同可用区Yes
NodeConfig.N.ServerTypestring节点类型Yes
NodeConfig.N.NodeCountint节点数量Yes
NodeConfig.N.ConfigIdstring节点规格IDYes
NodeConfig.N.DiskSizeint节点磁盘容量Yes
ChargeTypestring计费模式。枚举值为: Year,按年付费; Month,按月付费; Dynamic,按小时付费(需开启权限)。默认为月付Yes
OrderDetail.N.ProductNamestring计费项名称,CPU / MEM / DISKYes
OrderDetail.N.Multipleint计费项数量Yes
Couponstring代金券IdYes
Quantityfloat购买时长。默认: 1。按小时购买(Dynamic)时无需此参数。 月付时,此参数传0,代表了购买至月末Yes
Ipstring指定Ip地址No
Portstring指定端口No
PromotionIdstring活动ID。若有产品折扣,则由各产品与计费约定。No
ActivityIdint活动ID。No
RuleIdint活动规则ID。No
DbVersionstring集群版本号No
TemplateIdstring参数模版IDNo
AlertStrategyIds.Nint告警策略IDsNo
SecGroupInfo.N.SecGroupIdstring安全组 ID。至多可以同时绑定5个安全组。No
SecGroupInfo.N.Priorityint安全组优先级。取值范围[1, 5]No
Labels.N.Keystring用户资源标签的键值No
Labels.N.Valuestring用户资源标签的值No

响应字段

字段名类型描述信息必填
RetCodeint返回状态码,为 0 则为成功返回,非 0 为失败Yes
Actionstring操作指令名称Yes
Messagestring返回错误消息,当 RetCode 非 0 时提供详细的描述信息No
DataServiceData详情详情Yes

数据模型

ServiceData

字段名类型描述信息必填
Idstring服务IDYes

示例

请求示例

https://api.tnqacloud.com/?Action=CreateTiDBClusterService &Region=cn-zj &Zone=cn-zj-01 &ProjectId=blOBPWJc &Name=iMTHMnMQ &Password=FtKCWbcW &VPCId=ORjeezXY &SubnetId=itMUGQNY &PubUlbId=WeQAXmPc &DTType=fiNkIlva &NewCollationEnabled=9 &NewCollationsEnabledONFirstBootstrap=9 &NodeConfig.ServerType.n=kAodJBnS &NodeConfig.NodeCount.n=9 &NodeConfig.ConfigId.n=cmIjTfGr &NodeConfig.DiskSize.n=6 &Ip=irbCUrkH &Port=xzYEHHGj &ChargeType=IGGkitjS &OrderDetail.ProductName.n=lUGoWbBg &OrderDetail.Multiple.n=3 &Quantity=6.63376 &PromotionId=ynqYAdHH &ActivityId=tIMIQYTu &RuleId=OVQBLzVz &ChargeType=DOsijKmf &OrderDetail.ProductName.n=ChNDPbAB &OrderDetail.Multiple.n=9 &Coupon=XkKELZDP &Quantity=1.12136 &PromotionId=AZFhhXnf &ActivityId=zqUkeIgK &RuleId=zhnmXuPw &ChargeType=IbZfSGct &OrderDetail.N.ProductName=llKGbvXV &OrderDetail.N.Multiple=7 &Coupon=RkCCVkpl &Quantity=5.41324 &PromotionId=uQqsTXPj &ActivityId=wXEHTSmz &RuleId=GkvHkzoZ &DbVersion=sBFALbQE &TemplateId=vhPzGPgG &AlertStrategyIds.N=7 &SecGroupInfo.N.SecGroupId=ttKqHHLC &SecGroupInfo.N.Priority=3 &Labels.N.Key=kEVsquGB &Labels.N.Value=DvJHgcby

响应示例

{ "Action": "CreateTiDBClusterServiceResponse", "Data": {}, "RetCode": 0 }