调用CreateDedicatedHost接口添加云数据库专属集群MyBase主机。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 CreateDedicatedHost

系统规定参数。取值：CreateDedicatedHost。

RegionId String 是 cn-hangzhou

主机所在集群的地域ID。

DedicatedHostGroupId String 是 dhg-6w7q18iwt5jo****

目标集群ID。通过云数据库专属集群控制台集群列表查看目标集群ID。

说明 主机的数据库类型与集群的数据库类型一致。
ZoneId String 是 cn-hangzhou-i

可用区ID。调用DescribeRegions接口查询可用区ID。

VSwitchId String 是 vsw-bp133c8ifzxd3iv6q****

虚拟交换机的ID，可通过专有网络控制台查看目标虚拟机ID。
HostClass String 是 rds.g6.4xlarge

主机的规格。关于不同数据库类型支持的主机规格，详情请参见主机规格详情。

PayType String 是 prepaid

主机的付费类型。取值为prepaid（包年包月）。

Period String 否 Month

指定主机的预付费类型。取值：

  • Year：包年。
  • Month：包月。
UsedTime String 否 1

指定购买时长。取值：

  • 当参数Period=Year时，UsedTime取值为1~5。
  • 当参数Period=Month时，UsedTime取值为1~9。
ClientToken String 是 ETnLKlblzczshOTUbOCzSBZH8****

客户端生成该参数值，用于保证请求的幂等性，防止重复提交请求。该参数值只能包含ASCII字符，且不超过64个ASCII字符。
AutoRenew String 否 false

是否开启自动续费功能。取值：

  • true：开启。
  • false：不开启。
说明 不填写默认为false。
ImageCategory String 否 AliLinux

主机镜像。取值：

  • WindowsWithMssqlEntAlwaysonLicense：SQL Server集群版
  • WindowsWithMssqlStdLicense：SQL Server标准版
  • WindowsWithMssqlEntLicense：SQL Server企业版
  • WindowsWithMssqlWebLicense：SQL Server Web版
  • AliLinux：其他主机镜像
说明 创建SQL Server主机时，需要填写对应版本的主机镜像。
OsPassword String 否 Test123456

主机密码。 仅集群类型为私有部署集群时，支持创建主机密码。密码需符合如下要求：

  • 长度为8~30个字符。
  • 必须至少包含三项：大写字母、小写字母、数字和特殊字符。
  • 特殊符号：()\~!@#$%^&*-_+=|{}[]:;'<>,.?/
HostStorageType String 否 cloud_essd0

主机磁盘类型，仅针对Tair类型主机生效，当前只支持以下两种类型：

  • cloud_essd：PL1云盘
  • cloud_essd0：PL0云盘
HostStorage String 否 512

主机磁盘大小，仅针对Tair类型主机生效，取值范围是（单位GB）：

  • 512
  • 1024
  • 1536
  • 2048
  • 2560
  • 3072
  • 3584
  • 4096

返回数据

名称 类型 示例值 描述
OrderId Long 102565235

订单ID。
RequestId String C860658E-68A6-46C1-AF6E-3AE7C4D32375

请求ID。
DedicateHostList Array of DedicateHostList

已创建完成的主机信息。
DedicateHostList
DedicatedHostId String ch-bp108dki3wdl6****

已创建完成的主机ID。

示例

请求示例

http(s)://cddc.aliyuncs.com/?Action=CreateDedicatedHost
&RegionId=cn-hangzhou
&DedicatedHostGroupId=dhg-6w7q18iwt5jo****
&ZoneId=cn-hangzhou-i
&VSwitchId=vsw-bp133c8ifzxd3iv6q****
&HostClass=rds.g6.4xlarge
&PayType=prepaid
&Period=Month
&UsedTime=1
&ClientToken=ETnLKlblzczshOTUbOCzSBZH8****
&AutoRenew=false
&ImageCategory=AliLinux

&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateDedicatedHostResponse>
    <OrderId>102565235</OrderId>
    <RequestId>C860658E-68A6-46C1-AF6E-3AE7C4D32375</RequestId>
    <DedicateHostList>
        <DedicatedHostId> ch-bp108dki3wdl6****</DedicatedHostId>
    </DedicateHostList>
</CreateDedicatedHostResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "OrderId" : 102565235,
  "RequestId" : "C860658E-68A6-46C1-AF6E-3AE7C4D32375",
  "DedicateHostList" : [ {
    "DedicatedHostId" : " ch-bp108dki3wdl6****"
  } ]
}

错误码

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

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