- 最新动态
- 功能总览
- 服务公告
- 产品介绍
- 计费说明
- 快速入门
- 用户指南
- 最佳实践
- 开发指南
- API参考
- SDK参考
- 常见问题
- 视频帮助
- 文档下载
- 通用参考
链接复制成功!
创建实例
功能介绍
创建实例。
调用方法
请参见如何调用API。
URI
POST /v1.0/{project_id}/instances
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方式请参见获取项目ID。 |
请求参数
无
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
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实例规格。
|
ssl_enable |
Boolean |
是否打开SSL加密访问。
|
storage_spec_code |
String |
存储IO规格。
|
enterprise_project_id |
String |
企业项目ID。若为企业项目账号,该参数必填。 |
enable_acl |
Boolean |
是否开启访问控制列表。 |
ipv6_enable |
Boolean |
是否支持IPv6。
|
enable_publicip |
Boolean |
是否开启公网访问功能。默认不开启公网。
|
publicip_id |
String |
实例绑定的弹性IP地址的ID。 以英文逗号隔开多个弹性IP地址的ID。 如果开启了公网访问功能(即enable_publicip为true),该字段为必选。 |
broker_num |
Integer |
代理个数。 |
bss_param |
BssParam object |
表示包周期计费模式的相关参数。 如果为空,则默认计费模式为按需计费;否则是包周期方式。 |
参数 |
参数类型 |
描述 |
---|---|---|
is_auto_renew |
Boolean |
是否自动续订。 取值范围:
默认不自动续订。 |
charging_mode |
String |
计费模式。 功能说明:付费方式。 取值范围:
默认为postPaid。 |
is_auto_pay |
Boolean |
下单订购后,是否自动从客户的账户中支付,而不需要客户手动去进行支付。 取值范围:
默认为手动支付。 |
period_type |
String |
订购周期类型。 取值范围:
chargingMode为prePaid时生效且为必选值。 |
period_num |
Integer |
订购周期数。 取值范围:
chargingMode为prePaid时生效且为必选值。 |
请求示例
POST https://{endpoint}/v1.0/dms/{project_id}/instances
响应示例
状态码: 200
创建成功。
{ "instance_id" : "8959ab1c-7n1a-yyb1-a05t-93dfc361b32d" }
状态码
状态码 |
描述 |
---|---|
200 |
创建成功。 |
错误码
请参见错误码。