创建实例(按需)
功能介绍
创建实例,该接口创建的实例为按需计费的方式。
URI
POST /v2/{project_id}/instances
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,获取方式请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 是 | String | 参数解释: 实例名称。 约束限制: 由英文字母开头,且只能由英文字母、数字、中划线、下划线组成,长度4~64个字符。 取值范围: 不涉及。 默认取值: 不涉及。 |
| description | 否 | String | 参数解释: 实例的描述信息。 约束限制: 长度不超过1024的字符串。 \与"在json报文中属于特殊字符,如果参数值中需要显示\或者"字符,请在字符前增加转义字符\,比如\\或者\"。 取值范围: 不涉及。 默认取值: 不涉及。 |
| engine | 是 | String | 参数解释: 消息引擎类型。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| engine_version | 是 | String | 参数解释: 消息引擎的版本。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| storage_space | 是 | Integer | 参数解释: 存储空间,单位:GB。 约束限制: 不涉及。 取值范围: 不同的实例规格支持不同的存储配置。 默认取值: 不涉及。 |
| vpc_id | 是 | String | 参数解释: 虚拟私有云ID。 获取方法如下:参考《虚拟私有云 API参考》,调用“查询VPC列表”接口,从响应体中获取VPC ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| subnet_id | 是 | String | 参数解释: 子网信息。 获取方法如下:参考《虚拟私有云 API参考》,调用“查询子网列表”接口,从响应体中获取子网ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| security_group_id | 是 | String | 参数解释: 指定实例所属的安全组。 获取方法如下:参考《虚拟私有云 API参考》,调用“查询安全组列表”接口,从响应体中获取安全组ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| available_zones | 是 | Array of strings | 参数解释: 创建节点到指定且有资源的可用区ID。请参考查询可用区信息获取可用区ID。 该参数不能为空数组或者数组的值为空, 请注意查看该可用区是否有资源。 创建RocketMQ实例,支持节点部署在1个或3个及3个以上的可用区。在为节点指定可用区时,用逗号分隔开。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| product_id | 是 | String | 参数解释: RocketMQ实例规格。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| ssl_enable | 否 | Boolean | 参数解释: 是否打开SSL加密访问。 约束限制: 不涉及。 取值范围: 默认取值: false。 |
| storage_spec_code | 是 | String | 参数解释: 存储IO规格。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| enterprise_project_id | 否 | String | 参数解释: 企业项目ID。若为企业项目账号,该参数必填。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| enable_acl | 否 | Boolean | 参数解释: 是否开启访问控制列表。 约束限制: 不涉及。 取值范围: 默认取值: false。 |
| ipv6_enable | 否 | Boolean | 参数解释: 是否支持IPv6。 约束限制: 不涉及。 取值范围: 默认取值: false。 |
| proxy_enable | 否 | Boolean | 参数解释: 是否开启Proxy功能。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| enable_publicip | 否 | Boolean | 参数解释: 是否开启公网访问功能。默认不开启公网。 约束限制: 不涉及。 取值范围: 默认取值: false。 |
| disk_encrypted_enable | 否 | Boolean | 参数解释: 是否开启磁盘加密。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| disk_encrypted_key | 否 | String | 参数解释: 磁盘加密key,未开启磁盘加密时为空 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| publicip_id | 否 | String | 参数解释: 实例绑定的弹性IP地址的ID。 以英文逗号隔开多个弹性IP地址的ID。 如果开启了公网访问功能(即enable_publicip为true),该字段为必选。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| broker_num | 是 | Integer | 参数解释: 代理个数。RocketMQ 4.8.0该字段必选。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| tls_mode | 否 | String | 参数解释: 实例使用的安全协议。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码: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 | 创建实例成功。 |
错误码
请参见错误码。