创建实例
功能介绍
创建实例，该接口支持创建按需计费方式的实例。
URI
POST /v2/{engine}/{project_id}/instances
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
engine |
是 |
String |
消息引擎。 缺省值：rabbitmq |
|
project_id |
是 |
String |
项目ID，获取方式请参见获取项目ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
是 |
String |
实例名称。 由英文字符开头，只能由英文字母、数字、中划线、下划线组成，长度为4~64的字符。 |
|
description |
否 |
String |
实例的描述信息。 长度不超过1024的字符串。
说明：
\与"在json报文中属于特殊字符，如果参数值中需要显示\或者"字符，请在字符前增加转义字符\，比如\或者"。 |
|
engine |
是 |
String |
消息引擎：rabbitmq。 |
|
engine_version |
是 |
String |
消息引擎的版本。
|
|
storage_space |
是 |
Integer |
消息存储空间，单位GB。
|
|
access_user |
是 |
String |
认证用户名，只能由英文字母开头且由英文字母、数字、中划线、下划线组成，长度为4~64的字符。 |
|
password |
是 |
String |
实例的认证密码。 复杂度要求：
|
|
vpc_id |
是 |
String |
租户VPC ID。 获取方法如下：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找VPC ID。 |
|
security_group_id |
是 |
String |
租户安全组ID。 获取方法如下：登录虚拟私有云服务的控制台界面，在安全组的详情页面查找安全组ID。 |
|
subnet_id |
是 |
String |
子网ID。 获取方法如下：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。 |
|
available_zones |
是 |
Array of strings |
创建节点到指定且有资源的可用区ID。请参考查询可用区信息获取可用区ID。 该参数不能为空数组或者数组的值为空。 |
|
product_id |
是 |
String |
产品标识。 产品ID可以从查询产品规格列表获取。 如果产品ID为集群类型（即对应的type为cluster），broker_num字段为必选。 |
|
broker_num |
否 |
Integer |
代理个数。 当产品为单机类型，代理个数只能为1；当产品为集群类型，可选3、5、7个代理个数。 产品类型为single时:
产品类型为cluster时:
|
|
maintain_begin |
否 |
String |
维护时间窗开始时间，格式为HH:mm。
|
|
maintain_end |
否 |
String |
维护时间窗结束时间，格式为HH:mm。
|
|
enable_publicip |
否 |
Boolean |
RabbitMQ实例是否开启公网访问功能。
|
|
publicip_id |
否 |
String |
RabbitMQ实例绑定的弹性IP地址的ID。 如果开启了公网访问功能（即enable_publicip为true），该字段为必选。 |
|
ssl_enable |
否 |
Boolean |
是否打开SSL加密访问。
|
|
storage_spec_code |
是 |
String |
存储IO规格。 取值范围：
|
|
enterprise_project_id |
否 |
String |
企业项目ID。若为企业项目账号，该参数必填。 |
|
tags |
否 |
Array of TagEntity objects |
标签列表。 |
|
bss_param |
否 |
BssParam object |
表示包周期计费模式的相关参数。 如果为空，则默认计费模式为按需计费；否则是包周期方式。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
key |
否 |
String |
标签键。
|
|
value |
否 |
String |
标签值。
|
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
is_auto_renew |
否 |
Boolean |
是否自动续订。 取值范围：
默认不自动续订。 |
|
charging_mode |
否 |
String |
计费模式。 功能说明：付费方式。 取值范围：
默认为postPaid。 |
|
is_auto_pay |
否 |
Boolean |
下单订购后，是否自动从客户的账户中支付，而不需要客户手动去进行支付。 取值范围：
默认为手动支付。 |
|
period_type |
否 |
String |
订购周期类型。 取值范围：
chargingMode为prePaid时生效且为必选值。 |
|
period_num |
否 |
Integer |
订购周期数。 取值范围：
chargingMode为prePaid时生效且为必选值。 |
|
order_id |
否 |
String |
可以用于指定创建的包周期实例的订单号，该订单号从cbc获取。 如果不传则自动创建一个订单号。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
instance_id |
String |
实例ID。 |
请求示例
-
创建一个按需付费的RabbitMQ实例，版本为3.8.35，规格为2U4G*1，100GB的存储空间。
POST https://{endpoint}/v2/{engine}/{project_id}/instances { "name" : "rabbitmq-demo", "description" : "", "engine" : "RabbitMQ", "engine_version" : "3.8.35", "storage_space" : 100, "access_user" : "******", "password" : "******", "vpc_id" : "1e93f86e-13af-46c8-97d6-d40fa62b76c2", "security_group_id" : "0aaa0033-bf7f-4c41-a6c2-18cd04cad2c8", "subnet_id" : "b5fa806c-35e7-4299-b659-b39398dd4718", "available_zones" : [ "d573142f24894ef3bd3664de068b44b0" ], "product_id" : "c6.2u4g.single", "ssl_enable" : false, "enable_publicip" : false, "publicip_id" : "", "storage_spec_code" : "dms.physical.storage.high.v2" } -
创建一个包年包月的RabbitMQ实例，版本为3.8.35，规格为2U4G*1，100GB的存储空间。
POST https://{endpoint}/v2/{engine}/{project_id}/instances { "name" : "rabbitmq-demo", "description" : "", "engine" : "RabbitMQ", "engine_version" : "3.8.35", "storage_space" : 100, "access_user" : "******", "password" : "******", "vpc_id" : "1e93f86e-13af-46c8-97d6-d40fa62b76c2", "security_group_id" : "0aaa0033-bf7f-4c41-a6c2-18cd04cad2c8", "subnet_id" : "b5fa806c-35e7-4299-b659-b39398dd4718", "available_zones" : [ "d573142f24894ef3bd3664de068b44b0" ], "product_id" : "c6.2u4g.single", "ssl_enable" : false, "enable_publicip" : false, "publicip_id" : "", "storage_spec_code" : "dms.physical.storage.high.v2", "bss_param" : { "charging_mode" : "prePaid", "period_type" : "month", "period_num" : 1, "is_auto_pay" : true } }
响应示例
状态码： 200
创建实例成功。
{
"instance_id" : "8959ab1c-7n1a-yyb1-a05t-93dfc361b32d"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
创建实例成功。 |
错误码
请参见错误码。
