調用CreateDedicatedHost接口添加專屬集群主機。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DedicatedHostGroupId | string | 是 | 目標集群 ID。通過云數據庫專屬集群控制臺集群列表查看目標集群 ID。 說明
主機的數據庫類型與集群的數據庫類型一致。
| dhg-6w7q18iwt5jo**** |
| 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 |
| RegionId | string | 是 | 主機所在集群的地域 ID。 | cn-hangzhou |
| ZoneId | string | 是 | 可用區 ID。調用 DescribeRegions 接口查詢可用區 ID。 | cn-hangzhou-i |
| VSwitchId | string | 是 | 虛擬交換機的 ID，可通過專有網絡控制臺查看目標虛擬機 ID。 | vsw-bp133c8ifzxd3iv6q**** |
| ClusterType | string | 否 | MyBase 開放版使用，創建開放版集群類型：onACK、onECS | onACK |
| ClusterAlias | string | 否 | MyBase 開放版使用，開放版集群別名 | test-on-ack-cluster |
| VpcID | string | 否 | MyBase 開放版 onECS 集群指定 VPC ID | vpc-xxxxxx |
| ClusterServices | array | 否 | MyBase 開放版 onECS 實例關聯的服務。 | |
| string | 否 | MyBase 開放版 onECS 實例關聯的服務。 | "Orchestrator3.2.6,Promethus2.49.1,Grafana10.2.3" | |
| MyBaseEcsClass | object | 否 | MyBase 開放版 onECS 實例的參數。 | |
| ChargeType | string | 否 | 付費類型，取值如下：
| PrePaid |
| EcsClassCode | string | 否 | 實例規格。 | ecs.g7.large |
| Amount | long | 否 | 購買數量。 | 1 |
| Period | long | 否 | 購買 on ECS 主機的包年包月時長。當參數 ChargeType 取值為 PrePaid 時，Period 參數必填。 | 1 |
| PeriodType | string | 否 | 包年包月時長的單位，默認為 Month（月）。 | Month |
| SystemDiskSize | long | 否 | 系統盤容量。單位為 GB。 | 40 |
| SystemDiskCategory | string | 否 | 磁盤類型。 | cloud_essd |
| DataDiskSize | long | 否 | 數據盤大小。單位為 GB。 | 40 |
| DataDiskCategory | string | 否 | 數據盤類型。 | cloud_essd |
| DataDiskCount | long | 否 | 數據盤數量。 | 2 |
| AutoRenew | boolean | 否 | 是否自動續費，默認 false。 | false |
| Password | string | 否 | ECS 主機密碼。 | *********** |
| KeyPairName | string | 否 | 密鑰對名稱。 | test**** |
| SecurityGroupIds | array | 否 | 實例所屬安全組集合。 | |
| string | 否 | 實例所屬安全組。 | sg-uf64zn0tc9qakm2j**** | |
| Tags | array | 否 | 主機標簽信息。 | |
| string | 否 | 主機標簽信息。 | {\"key1\":\"value1\"} | |
| InternetMaxBandwidthOut | long | 否 | 公網出帶寬最大值，單位為 Mbit/s。 默認值：0。設定為大于 0 時會自動創建公網 IP。 | 100 |
| InternetChargeType | string | 否 | 網絡計費類型。取值范圍：
| PayByTraffic |
| DepolymentSetId | string | 否 | 部署集 ID。 | **** |
返回參數
示例
正常返回示例
JSON格式
{
"OrderId": 102565235,
"RequestId": "C860658E-68A6-46C1-AF6E-3AE7C4D32375",
"ClusterName": "ca-2ze0x527ovq3y****",
"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. | 資源不足，分配失敗 |
訪問錯誤中心查看更多錯誤碼。