CreateMyBase - CreateMyBase_云数据库专属集群(MyBase)-阿里云帮助中心

创建MyBase专有版主机，如未提供集群信息会自动创建MyBase专有版集群。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。	ap-southeast-1
DedicatedHostGroupDescription	string	否	专属集群的名称。	testDedicatedGroupName
Engine	string	是	数据库类型，取值： alisql。 tair。	alisql
SecurityGroupId	string	是	安全组 ID，可以指定多个安全组，多个安全组以英文逗号（,）分隔，传入格式为 sg-t4neld965n89ocvt**,sg-t4neld965n89ocvu**。	sg-t4neld965n89ocvt**,sg-t4neld965n89ocvu**
ZoneId	string	是	可用区 ID，您可以调用 DescribeRegions 查看地域下的可用区 ID。	ap-southeast-1a
VSwitchId	string	是	虚拟交换机 ID。	vsw-t4ni3mzqqw98vt317****
ECSClassList	array<object>	是	ECS 规格信息。	[{"sysDiskCapacity":40,"instanceType":"ecs.d2s.10xlarge","nodeCount":1,"sysDiskType":"cloud_essd"}]
	object	是
sysDiskCapacity	integer	是	系统盘容量，单位为 GB。	40
instanceType	string	是	ECS 规格。	ecs.c6.large
nodeCount	integer	是	ECS 购买数量。	1
sysDiskType	string	是	系统盘磁盘类型，取值： cloud_essd。 cloud_ssd。 cloud_efficiency。 cloud。	cloud_essd
diskType	string	否	数据盘类型，取值： cloud_essd。 cloud_ssd。 cloud_efficiency。 cloud。	cloud_essd
diskCapacity	integer	否	数据盘容量。	50
diskCount	integer	否	挂载数据盘个数。	1
dataDiskPerformanceLevel	string	否	数据盘 PL 等级。	PL1
systemDiskPerformanceLevel	string	否	系统盘 PL 等级。	PL1
sysDiskAutoSnapshotPolicyId	string	否	系统盘快照策略。	sp-bp1i9wclcwpe52th****
sysDiskEncrypted	boolean	否	系统盘是否加密，系统盘只有为 ESSD 云盘时才可以设置。	false
sysDiskKMSKeyId	string	否	系统盘使用的 KMS 密钥 ID，使用 ECS 默认加密服务时不用传值，系统盘只有为 ESSD 云盘时才可以设置。	b3c210f3-3ffb-480e-9ca2-****
dataDiskAutoSnapshotPolicyId	string	否	数据盘快照策略。	sp-bp1i9wclcwpe52th****
dataDiskEncrypted	boolean	否	数据盘是否加密。	false
dataDiskKMSKeyId	string	否	数据盘使用的 KMS 密钥 ID，使用 ECS 默认加密服务时不用传值。	b3c210f3-3ffb-480e-9ca2-****
PayType	string	是	付费类型，目前仅支持 PrePaid。	PrePaid
Period	string	是	购买时长。	1
ClientToken	string	否	保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符，且不能超过 64 个字符。	4ed77dd1-ff52-407e-ac58-dc251822****
AutoRenew	string	否	是否开启自动续费，取值： true：开启。 false（默认值）：关闭。	false
ImageId	string	否	自定义镜像 ID。说明若您需要使用默认镜像，无需填写。	m-8vb11a30rc63x37c****
OsPassword	string	否	主机登录密码，可以稍后设置。密码须符合如下要求：长度为 8~30 个字符。必须至少包含三项：大写字母、小写字母、数字和特殊字符。特殊符号`()\`~!@#$%^&*-_+=\|{}[]:;'<>,.?/` 说明如果需要稍后设置主机登录密码，此参数填写空字符串即可。如果需要设置主机登录密码，建议您使用 HTTPS 协议发送请求，避免密码泄露。	Test123456
DedicatedHostGroupId	string	否	已有专有版专属集群 ID。	dhg-6dx5n9gjs96u****
PeriodType	string	否	预付费类型，目前仅支持 Monthly（包月）。	Monthly
VpcId	string	是	专有网络 VPCID。	vpc-t4nbtmekgxotv0d3y****
KeyPairName	string	否	密钥对名称。	test_key_pair
PasswordInherit	string	否	是否使用镜像的默认密码。 false（默认值）：不使用 true：使用说明若使用镜像的默认密码，OSPassword 参数无需填写。	false
EcsHostName	string	否	Windows 系统：长度为 2～15 个字符，允许使用大小写字母、数字。不能仅使用数字。其他操作系统（Linux 等）：长度为 2～64 个字符，允许使用点号（.）分隔字符成多段，每段允许使用大小写字母、数字，但不能连续使用点号（.）。不能以点号（.）开头或结尾。	LocalHostname
EcsInstanceName	string	否	实例名称。长度为 2~128 个字符，必须以大小写字母或中文开头，不能以 http://和 https://开头。可以包含中文、英文、数字、半角冒号（:）、下划线（_）、半角句号（.）或者短划线（-）。默认值为实例的 InstanceId。	k8snode1
EcsDeploymentSetId	string	否	云服务器部署集 ID。	ds-bp1brhwhoqinyjd6****
EcsUniqueSuffix	string	否	当创建多台实例时，是否为 HostName 和 InstanceName 自动添加有序后缀。有序后缀从 001 开始递增，最大不能超过 999。取值说明： true：添加。 false（默认值）：不添加。当 HostName 或 InstanceName 按照指定排序格式设置，未设置命名后缀 name_suffix，即命名格式为 name_prefix[begin_number,bits]时，UniqueSuffix 不生效，名称仅按照指定顺序排序。	false
InternetChargeType	string	否	网络计费类型。取值范围： PayByBandwidth：按固定带宽计费。 PayByTraffic：按使用流量计费。	PayByBandwidth
InternetMaxBandwidthOut	integer	否	公网出带宽最大值，单位为 Mbit/s。取值范围：0~100。默认值：0。设定为大于 0 时会自动创建公网 IP。	0
AutoPay	boolean	否	创建主机时，是否自动支付。 false：只生成订单不扣费，需要在【我的订单】页面手动确认支付。 true（默认值）：自动支付，请确保支付方式余额充足，否则会生成异常订单，只能作废订单。	false
ResourceGroupId	string	否	资源组 ID。	rg-bp67acfmxazb4p****
UserDataInBase64	boolean	否	自定义数据是否采用 Base64 格式编码。	true
UserData	string	否	用户自定义脚本数据，原始数据最多为 16KB。	ZWNobyBoZWxsbyBlY3Mh
Tags	array<object>	否	主机标签信息。
	object	否
Key	string	否	主机的标签键。一旦传入该值，则不允许为空字符串。最多支持 128 个字符，不能以 aliyun 和 acs:开头，不能包含 http://或 https://。	TestKey
Value	string	否	主机的标签值。一旦传入该值，则不允许为空字符串。最多支持 128 个字符，不能以 acs:开头，不能包含 http://或 https://。	TestValue

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	937F6B32-A796-53A0-99C8-F7A9660E****
OrderList	array<object>	订单列表。
	object
OrderId	string	订单 ID。	21767077790****
CreateTimestamp	long	主机创建成功的时间戳。	1661498032347
ECSInstanceIds	string	已创建成功的 ECS 主机 ID，多个主机 ID 以英文逗号（,）分隔。	["i-t4n1tandot8j3axw**","i-t4n1tandot8j3axv**"]
DedicatedHostGroupName	string	创建的专有版集群 ID。	dhg-7a9********

示例

正常返回示例

JSON格式

{
  "RequestId": "937F6B32-A796-53A0-99C8-F7A9660E****",
  "OrderList": {
    "OrderList": [
      {
        "OrderId": "21767077790****",
        "CreateTimestamp": 1661498032347,
        "ECSInstanceIds": "[\"i-t4n1tandot8j3axw****\",\"i-t4n1tandot8j3axv****\"]",
        "DedicatedHostGroupName": "dhg-7a9********"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter	The parameter is invalid.	无效参数
400	COMMODITY.INVALID_COMPONENT	Invalid component.	-
400	InvalidAccountPassword.Format	The account password format is invalid.	密码格式错误
400	InsufficientResourceCapacity	No host is available for the requested instance.	资源不足，分配失败

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2023-11-27	OpenAPI 错误码发生变更	查看变更详情
2023-11-22	OpenAPI 错误码发生变更	查看变更详情
2023-11-21	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情
2023-09-07	OpenAPI 错误码发生变更	查看变更详情
2023-08-14	OpenAPI 错误码发生变更	查看变更详情
2023-08-11	OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2022-11-23	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情
2022-09-19	OpenAPI 错误码发生变更	查看变更详情