更新时间:2024-04-08 GMT+08:00

创建实例(按需)

功能介绍

创建实例,该接口创建的实例为按需计费的方式。

URI

POST /v2/{project_id}/instances

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方式请参见获取项目ID

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

name

String

实例名称。

由英文字符开头,只能由英文字母、数字、中划线、下划线组成,长度为4~64的字符。

description

String

实例的描述信息。

长度不超过1024的字符串。

说明:

\与"在json报文中属于特殊字符,如果参数值中需要显示\或者"字符,请在字符前增加转义字符\,比如\或者"。

engine

String

消息引擎。取值填写为:reliability。

engine_version

String

消息引擎的版本。取值填写为:4.8.0。

storage_space

Integer

存储空间。

vpc_id

String

虚拟私有云ID。

获取方法如下:登录虚拟私有云服务的控制台界面,在虚拟私有云的详情页面查找VPC ID。

subnet_id

String

子网信息。

获取方法如下:登录虚拟私有云服务的控制台界面,单击VPC下的子网,进入子网详情页面,查找网络ID。

security_group_id

String

指定实例所属的安全组。

获取方法如下:登录虚拟私有云服务的控制台界面,在安全组的详情页面查找安全组ID。

available_zones

Array of strings

创建节点到指定且有资源的可用区ID。请参考查询可用区信息获取可用区ID。 该参数不能为空数组或者数组的值为空, 请注意查看该可用区是否有资源。

创建RocketMQ实例,支持节点部署在1个或3个及3个以上的可用区。在为节点指定可用区时,用逗号分隔开。

product_id

String

RocketMQ实例规格。

  • c6.4u8g.cluster:单个代理最大Topic数4000,单个代理最大消费组数4000

  • c6.8u16g.cluster:单个代理最大Topic数8000,单个代理最大消费组数8000

  • c6.12u24g.cluster:单个代理最大Topic数12000,单个代理最大消费组数12000

  • c6.16u32g.cluster:单个代理最大Topic数16000,单个代理最大消费组数16000

ssl_enable

Boolean

是否打开SSL加密访问。

  • true:打开SSL加密访问。

  • false:不打开SSL加密访问。

storage_spec_code

String

存储IO规格。

  • dms.physical.storage.high.v2: 高IO类型磁盘

  • dms.physical.storage.ultra.v2: 超高IO类型磁盘

enterprise_project_id

String

企业项目ID。若为企业项目账号,该参数必填。

enable_acl

Boolean

是否开启访问控制列表。

ipv6_enable

Boolean

是否支持IPv6。

  • true: 支持

  • false:不支持

缺省值:false

enable_publicip

Boolean

是否开启公网访问功能。默认不开启公网。

  • true:开启

  • false:不开启

缺省值:false

publicip_id

String

实例绑定的弹性IP地址的ID。

以英文逗号隔开多个弹性IP地址的ID。

如果开启了公网访问功能(即enable_publicip为true),该字段为必选。

broker_num

Integer

代理个数

缺省值:1

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

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

创建实例成功。

错误码

请参见错误码