调用CreateDedicatedHost接口添加专属集群主机。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 主机所在集群的地域 ID。 | cn-hangzhou |
DedicatedHostGroupId | string | 是 | 目标集群 ID。通过云数据库专属集群控制台集群列表查看目标集群 ID。 说明
主机的数据库类型与集群的数据库类型一致。
| dhg-6w7q18iwt5jo**** |
ZoneId | string | 是 | 可用区 ID。调用 DescribeRegions 接口查询可用区 ID。 | cn-hangzhou-i |
VSwitchId | string | 是 | 虚拟交换机的 ID,可通过专有网络控制台查看目标虚拟机 ID。 | vsw-bp133c8ifzxd3iv6q**** |
HostClass | string | 是 | 主机的规格。关于不同数据库类型支持的主机规格,详情请参见主机规格详情。 | rds.g6.4xlarge |
PayType | string | 是 | 主机的付费类型。取值为 prepaid(包年包月)。 | prepaid |
Period | string | 否 | 指定主机的预付费类型。取值:
| Month |
UsedTime | string | 否 | 指定购买时长。取值:
| 1 |
ClientToken | string | 是 | 客户端生成该参数值,用于保证请求的幂等性,防止重复提交请求。该参数值只能包含 ASCII 字符,且不超过 64 个 ASCII 字符。 | ETnLKlblzczshOTUbOCzSBZH8**** |
AutoRenew | string | 否 | 是否开启自动续费功能。取值:
说明
不填写默认为 false。
| false |
ImageCategory | string | 否 | 主机镜像。取值:
说明
创建 SQL Server 主机时,需要填写对应版本的主机镜像。
| AliLinux |
OsPassword | string | 否 | 主机密码。 仅集群类型为私有部署集群时,支持创建主机密码。密码需符合如下要求:
| Test123456 |
HostStorageType | string | 否 | 主机磁盘类型,仅针对 Tair 类型主机生效,当前只支持以下两种类型:
| cloud_essd0 |
HostStorage | string | 否 | 主机磁盘大小,仅针对 Tair 类型主机生效,取值范围是(单位 GB):
| 512 |
返回参数
示例
正常返回示例
JSON
格式
{
"OrderId": 102565235,
"RequestId": "C860658E-68A6-46C1-AF6E-3AE7C4D32375",
"DedicateHostList": {
"DedicateHostList": [
{
"DedicatedHostId": " ch-bp108dki3wdl6****"
}
]
}
}
错误码
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. | 资源不足,分配失败 |
访问错误中心查看更多错误码。