创建实例(按需)
功能介绍
创建实例,该接口创建的实例为按需计费的方式。
URI
POST /v2/{project_id}/instances
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
是 |
String |
实例名称。 由英文字符开头,只能由英文字母、数字、中划线、下划线组成,长度为4~64的字符。 |
description |
否 |
String |
实例的描述信息。 长度不超过1024的字符串。
说明:
\与"在json报文中属于特殊字符,如果参数值中需要显示\或者"字符,请在字符前增加转义字符\,比如\或者"。 |
engine |
是 |
String |
消息引擎。取值填写为:reliability。 |
engine_version |
是 |
String |
消息引擎的版本。取值填写为:4.8.0。 |
storage_space |
是 |
Integer |
存储空间。 |
vpc_id |
是 |
String |
虚拟私有云ID。 获取方法如下:
|
subnet_id |
是 |
String |
子网信息。 获取方法如下:
|
security_group_id |
是 |
String |
指定实例所属的安全组。 获取方法如下:
|
available_zones |
是 |
Array of strings |
创建节点到指定且有资源的可用区ID。该参数不能为空数组或者数组的值为空, 请注意查看该可用区是否有资源。 创建RocketMQ实例,支持节点部署在1个或3个及3个以上的可用区。在为节点指定可用区时,用逗号分隔开。 |
product_id |
是 |
String |
RocketMQ实例规格。
|
ssl_enable |
否 |
Boolean |
是否打开SSL加密访问。
|
storage_spec_code |
是 |
String |
存储IO规格。
|
enterprise_project_id |
否 |
String |
企业项目ID。若为企业项目帐号,该参数必填。 |
enable_acl |
否 |
Boolean |
是否开启访问控制列表。 |
ipv6_enable |
否 |
Boolean |
是否支持IPV6。
缺省值:false |
enable_publicip |
否 |
Boolean |
是否开启公网访问功能。默认不开启公网。
缺省值:false |
publicip_id |
否 |
String |
实例绑定的弹性IP地址的ID。 以英文逗号隔开多个弹性IP地址的ID。 如果开启了公网访问功能(即enable_publicip为true),该字段为必选。 |
broker_num |
是 |
Integer |
代理个数 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
instance_id |
String |
实例ID。 |
请求示例
创建按需实例。
POST https://{endpoint}/v2/{project_id}/instances { "name" : "reliability-1751840557", "description" : "", "engine" : "reliability", "engine_version" : "4.8.0", "storage_space" : 600, "vpc_id" : "3db8490c-4d6d-4d8f-8d3f-047b0de4c5cf", "subnet_id" : "0a0f1fcb-f019-458d-b9e5-301867394d50", "security_group_id" : "23c5977f-ff33-4b95-a73e-08d8a0bc4e6c", "available_zones" : [ "9f1c5806706d4c1fb0eb72f0a9b18c77" ], "product_id" : "c6.4u8g.cluster", "enterprise_project_id" : "0", "ssl_enable" : false, "storage_spec_code" : "dms.physical.storage.ultra.v2", "ipv6_enable" : false, "enable_publicip" : false, "publicip_id" : "", "broker_num" : 1 }
响应示例
状态码: 200
创建实例成功。
{ "instance_id" : "8959ab1c-7n1a-yyb1-a05t-93dfc361b32d" }
状态码
状态码 |
描述 |
---|---|
200 |
创建实例成功。 |
错误码
请参见错误码。