文档

CreateDedicatedHost - 添加专属集群主机

调用CreateDedicatedHost接口添加专属集群主机。

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
DedicatedHostGroupIdstring

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

说明 主机的数据库类型与集群的数据库类型一致。
dhg-6w7q18iwt5jo****
HostClassstring

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

rds.g6.4xlarge
PayTypestring

主机的付费类型。取值为 prepaid(包年包月)。

prepaid
Periodstring

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

  • Year:包年。
  • Month:包月。
  • Week:包周。
Month
UsedTimestring

指定购买时长。取值:

  • 当参数 Period=Year 时,UsedTime 取值为 1~5
  • 当参数 Period=Month 时,UsedTime 取值为 1~9
  • 当参数 Period=Week 时,UsedTime 取值为 123
1
ClientTokenstring

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

ETnLKlblzczshOTUbOCzSBZH8****
AutoRenewstring

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

  • true:开启。
  • false:不开启。
说明 不填写默认为 false
false
ImageCategorystring

主机镜像。取值:

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

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

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

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

  • cloud_essd:PL1 云盘
  • cloud_essd0:PL0 云盘
cloud_essd0
HostStoragestring

主机磁盘大小,仅针对 Tair 类型主机生效,取值范围是(单位 GB):

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

主机所在集群的地域 ID

cn-hangzhou
ZoneIdstring

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

cn-hangzhou-i
VSwitchIdstring

虚拟交换机的 ID,可通过专有网络控制台查看目标虚拟机 ID。

vsw-bp133c8ifzxd3iv6q****
ClusterTypestring

MyBase 开放版使用,创建开放版集群类型:onACK、onECS

onACK
ClusterAliasstring

MyBase 开放版使用,开放版集群别名

test-on-ack-cluster
VpcIDstring

MyBase 开放版 onECS 集群指定 VPC ID

vpc-xxxxxx
ClusterServicesarray

MyBase 开放版 onECS 实例关联的服务。

string

MyBase 开放版 onECS 实例关联的服务。

"Orchestrator3.2.6,Promethus2.49.1,Grafana10.2.3"
MyBaseEcsClassobject

MyBase 开放版 onECS 实例的参数。

ChargeTypestring

付费类型,取值如下:

  • PrePaid:预付费。
  • PostPaid:后付费。
PrePaid
EcsClassCodestring

实例规格。

ecs.g7.large
Amountlong

购买数量。

1
Periodlong

购买 on ECS 主机的包年包月时长。当参数 ChargeType 取值为 PrePaid 时,Period 参数必填。

1
PeriodTypestring

包年包月时长的单位,默认为 Month(月)。

Month
SystemDiskSizelong

系统盘容量。单位为 GB。

40
SystemDiskCategorystring

磁盘类型。

cloud_essd
DataDiskSizelong

数据盘大小。单位为 GB。

40
DataDiskCategorystring

数据盘类型。

cloud_essd
DataDiskCountlong

数据盘数量。

2
AutoRenewboolean

是否自动续费,默认 false。

false
Passwordstring

ECS 主机密码。

***********
KeyPairNamestring

密钥对名称。

test****
SecurityGroupIdsarray

实例所属安全组集合。

string

实例所属安全组。

sg-uf64zn0tc9qakm2j****
Tagsarray

主机标签信息。

string

主机标签信息。

{\"key1\":\"value1\"}
InternetMaxBandwidthOutlong

公网出带宽最大值,单位为 Mbit/s。

默认值:0。设定为大于 0 时会自动创建公网 IP。

100
InternetChargeTypestring

网络计费类型。取值范围:

  • PayByBandwidth:按固定带宽计费。
  • PayByTraffic:按使用流量计费。
PayByTraffic
DepolymentSetIdstring

部署集 ID。

****

返回参数

名称类型描述示例值
object
OrderIdlong

订单 ID。

102565235
RequestIdstring

请求 ID。

C860658E-68A6-46C1-AF6E-3AE7C4D32375
ClusterNamestring

集群名称。

ca-2ze0x527ovq3y****
DedicateHostListobject []

已创建完成的主机信息。

DedicatedHostIdstring

已创建完成的主机 ID。

ch-bp108dki3wdl6****

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400InvalidParameterThe parameter is invalid.无效参数
400COMMODITY.INVALID_COMPONENTInvalid component.-
400InvalidAccountPassword.FormatThe account password format is invalid.密码格式错误
400InsufficientResourceCapacityNo host is available for the requested instance.资源不足,分配失败

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

  • 本页导读 (1)