# 创建实例 - CreateInstanceByEngine #### 功能介绍 创建实例，该接口支持创建按需和包周期两种计费方式的实例。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-hrm/api-call-process.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-hrm/api-grant-policy.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | dms:instance:create | Write | rocketmq \* | - g:RequestTag/\ - g:TagKeys - g:EnterpriseProjectId - dms:ssl - dms:publicIp | - | - vpc:vpcs:get - vpc:vpcs:list - vpc:ports:get - vpc:ports:create - vpc:ports:update - vpc:ports:delete - vpc:securityGroups:get - vpc:subnets:get - eip:publicIps:get - eip:publicIps:list - eip:publicIps:update | #### URI POST /v2/{engine}/{project_id}/instances 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | engine | 是 | String | **参数解释**： 消息引擎类型。 **约束限制**： 不涉及。 **取值范围**： - rocketmq：RocketMQ消息引擎。 - reliability：RocketMQ消息引擎别称。 **默认取值**： 不涉及。 | | project_id | 是 | String | **参数解释**： 项目ID，获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-hrm/hrm-api-0011.html)。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 是 | String | **参数解释**： 实例名称。 **约束限制**： 由英文字母开头，且只能由英文字母、数字、中划线、下划线组成，长度4\~64个字符。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | description | 否 | String | **参数解释**： 实例的描述信息。 **约束限制**： 长度不超过1024的字符串。 \\与"在json报文中属于特殊字符，如果参数值中需要显示\\或者"字符，请在字符前增加转义字符\\，比如\\\\或者\\"。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | engine | 是 | String | **参数解释**： 消息引擎类型。 **约束限制**： 不涉及。 **取值范围**： - rocketmq：RocketMQ消息引擎。 - reliability：RocketMQ消息引擎别称。 **默认取值**： 不涉及。 | | engine_version | 是 | String | **参数解释**： 消息引擎的版本。 **约束限制**： 不涉及。 **取值范围**： - 4.8.0 - 5.x **默认取值**： 不涉及。 | | 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。请参考[查询可用区信息](https://support.huaweicloud.com/api-hrm/ListAvailableZones.html)获取可用区ID。 **约束限制**： 该参数不能为空数组或者数组的值为空， 请注意查看该可用区是否有资源。 创建RocketMQ实例，在为节点指定可用区时，用逗号分隔开。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | product_id | 是 | String | **参数解释**： RocketMQ实例规格。 **约束限制**： 不涉及。 **取值范围**： - c6.4u8g.cluster.small：单个代理最大Topic数2000，单个代理最大消费组数2000 - c6.4u8g.cluster：单个代理最大Topic数4000，单个代理最大消费组数4000 - c6.8u16g.cluster：单个代理最大Topic数8000，单个代理最大消费组数8000 - c6.12u24g.cluster：单个代理最大Topic数12000，单个代理最大消费组数12000 - c6.16u32g.cluster：单个代理最大Topic数16000，单个代理最大消费组数16000 - rocketmq.b1.large.1：RocketMQ 5.x 基础版单机规格，实例TPS 500 - rocketmq.b2.large.4：RocketMQ 5.x 基础版集群规格，实例TPS 2000 - rocketmq.b2.large.8：RocketMQ 5.x 基础版集群规格，实例TPS 4000 - rocketmq.b2.large.12：RocketMQ 5.x 基础版集群规格，实例TPS 6000 - rocketmq.p1.large.1：RocketMQ 5.x 专业版单机规格，实例TPS 500 - rocketmq.p2.large.8：RocketMQ 5.x 专业版集群规格，实例TPS 4000 - rocketmq.p2.large.12：RocketMQ 5.x 专业版集群规格，实例TPS 6000 - rocketmq.p2.large.20：RocketMQ 5.x 专业版集群规格，实例TPS 10000 - rocketmq.p2.large.40：RocketMQ 5.x 专业版集群规格，实例TPS 20000 - rocketmq.p2.large.100：RocketMQ 5.x 专业版集群规格，实例TPS 50000 - rocketmq.p2.large.150：RocketMQ 5.x 专业版集群规格，实例TPS 75000 - rocketmq.p2.large.200：RocketMQ 5.x 专业版集群规格，实例TPS 100000 - rocketmq.p2.large.300：RocketMQ 5.x 专业版集群规格，实例TPS 150000 **默认取值**： 不涉及。 | | ssl_enable | 否 | Boolean | **参数解释**： 是否打开SSL加密访问。 **约束限制**： 不涉及。 **取值范围**： - true：打开SSL加密访问。 - false：不打开SSL加密访问。 **默认取值**： false。 | | storage_spec_code | 是 | String | **参数解释**： 存储IO规格。 **约束限制**： 不涉及。 **取值范围**： - dms.physical.storage.high.v2：高IO类型磁盘。RocketMQ 5.x专业版不支持该取值。 - dms.physical.storage.ultra.v2：超高IO类型磁盘。 - dms.physical.storage.general：使用通用型SSD的磁盘类型。 - dms.physical.storage.extreme：使用极速型SSD的磁盘类型。 **默认取值**： 不涉及。 | | enterprise_project_id | 否 | String | **参数解释**： 企业项目ID。若为企业项目账号，该参数必填。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | enable_acl | 否 | Boolean | **参数解释**： 是否开启访问控制列表。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | ipv6_enable | 否 | Boolean | **参数解释**： 是否支持IPv6。 **约束限制**： 不涉及。 **取值范围**： - true：支持。 - false：不支持。 **默认取值**： false。 | | ipv6_broker_address | 否 | String | **参数解释**： 业务数据IPv6的地址。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | ipv6_namesrv_address | 否 | String | **参数解释**： 元数据IPv6的地址。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | proxy_enable | 否 | Boolean | **参数解释**： 是否开启Proxy功能。 **约束限制**： 不涉及。 **取值范围**： - true：支持。 - false：不支持。 **默认取值**： false。 | | enable_publicip | 否 | Boolean | **参数解释**： 是否开启公网访问功能。默认不开启公网。 **约束限制**： 不涉及。 **取值范围**： - true：开启公网。 - false：不开启公网。 **默认取值**： false。 | | disk_encrypted_enable | 否 | Boolean | **参数解释**： 是否开启磁盘加密。 **约束限制**： 不涉及。 **取值范围**： - true：开启。 - false：不开启。 **默认取值**： false。 | | disk_encrypted_key | 否 | String | **参数解释**： 磁盘加密key，未开启磁盘加密时为空。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | publicip_id | 否 | String | **参数解释**： 实例绑定的弹性IP地址的ID。 **约束限制**： 以英文逗号隔开多个弹性IP地址的ID。 如果开启了公网访问功能（即enable_publicip为true），该字段为必选。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | broker_num | 是 | Integer | **参数解释**： 代理个数。RocketMQ 4.8.0该字段必选。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | arch_type | 否 | String | **参数解释**： 架构类型。 **约束限制**： 不涉及。 **取值范围**： - X86：X86架构。 - ARM：鲲鹏架构。 **默认取值**： X86。 | | tls_mode | 否 | String | **参数解释**： 实例使用的安全协议。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | bss_param | 否 | [BssParam] object | **参数解释**： 表示包周期计费模式的相关参数。如果为空，则默认计费模式为按需计费；否则是包周期方式。 **约束限制**： 不涉及。 **取值范围**： 不涉及 **默认取值**： 不涉及。 | 表3BssParam | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | is_auto_renew | 否 | Boolean | **参数解释**： 是否自动续订。 **约束限制**： 不涉及。 **取值范围**： - true：自动续订。 - false：不自动续订。 **默认取值**： false。 | | charging_mode | 否 | String | **参数解释**： 计费模式。 **约束限制**： 不涉及。 **取值范围**： - prePaid：预付费，即包年包月。 - postPaid：后付费，即按需付费。 **默认取值**： postPaid。 | | is_auto_pay | 否 | Boolean | **参数解释**： 下单订购后，是否自动从客户的账户中支付，无需客户手动支付。 **约束限制**： 不涉及。 **取值范围**： - true：是（自动支付）。 - false：否（需要客户手动支付）。 **默认取值**： 不涉及。 | | period_type | 否 | String | **参数解释**： 订购周期类型。 **约束限制**： chargingMode为prePaid时生效且为必选值。 **取值范围**： - month：月 - year：年 **默认取值**： 不涉及。 | | period_num | 否 | Integer | **参数解释**： 订购周期数。 **约束限制**： chargingMode为prePaid时生效且为必选值。 **取值范围**： - periodType=month（周期类型为月）时，取值为\[1，9\]。 - periodType=year（周期类型为年）时，取值为\[1，3\]。 **默认取值**： 不涉及。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | instance_id | String | **参数解释**： 实例ID。 **取值范围**： 不涉及。 | #### 请求示例 创建一个RocketMQ实例，规格为4U8G\*1，600GB的存储空间，按需付费。 ``` POST https://{endpoint}/v2/reliability/{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, "disk_encrypted_enable" : true, "disk_encrypted_key" : "********-b953-4875-a743-************", "publicip_id" : "", "broker_num" : 1 } ``` #### 响应示例 **状态码：200** 创建实例成功。 ``` { "instance_id" : "8959ab1c-7n1a-yyb1-a05t-93dfc361b32d" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 创建一个RocketMQ实例，规格为4U8G\*1，600GB的存储空间，按需付费。 ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.rocketmq.v2.region.RocketMQRegion; import com.huaweicloud.sdk.rocketmq.v2.*; import com.huaweicloud.sdk.rocketmq.v2.model.*; import java.util.List; import java.util.ArrayList; public class CreateInstanceByEngineSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); RocketMQClient client = RocketMQClient.newBuilder() .withCredential(auth) .withRegion(RocketMQRegion.valueOf("")) .build(); CreateInstanceByEngineRequest request = new CreateInstanceByEngineRequest(); request.withEngine(CreateInstanceByEngineRequest.EngineEnum.fromValue("{engine}")); CreateInstanceByEngineReq body = new CreateInstanceByEngineReq(); List listbodyAvailableZones = new ArrayList<>(); listbodyAvailableZones.add("9f1c5806706d4c1fb0eb72f0a9b18c77"); body.withBrokerNum(1); body.withPublicipId(""); body.withDiskEncryptedKey("********-b953-4875-a743-************"); body.withDiskEncryptedEnable(true); body.withEnablePublicip(false); body.withIpv6Enable(false); body.withEnterpriseProjectId("0"); body.withStorageSpecCode("dms.physical.storage.ultra.v2"); body.withSslEnable(false); body.withProductId("c6.4u8g.cluster"); body.withAvailableZones(listbodyAvailableZones); body.withSecurityGroupId("23c5977f-ff33-4b95-a73e-08d8a0bc4e6c"); body.withSubnetId("0a0f1fcb-f019-458d-b9e5-301867394d50"); body.withVpcId("3db8490c-4d6d-4d8f-8d3f-047b0de4c5cf"); body.withStorageSpace(600); body.withEngineVersion("4.8.0"); body.withEngine("reliability"); body.withDescription(""); body.withName("reliability-1751840557"); request.withBody(body); try { CreateInstanceByEngineResponse response = client.createInstanceByEngine(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - [Python] 创建一个RocketMQ实例，规格为4U8G\*1，600GB的存储空间，按需付费。 ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkrocketmq.v2.region.rocketmq_region import RocketMQRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkrocketmq.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = RocketMQClient.new_builder() \ .with_credentials(credentials) \ .with_region(RocketMQRegion.value_of("")) \ .build() try: request = CreateInstanceByEngineRequest() request.engine = "{engine}" listAvailableZonesbody = [ "9f1c5806706d4c1fb0eb72f0a9b18c77" ] request.body = CreateInstanceByEngineReq( broker_num=1, publicip_id="", disk_encrypted_key="********-b953-4875-a743-************", disk_encrypted_enable=True, enable_publicip=False, ipv6_enable=False, enterprise_project_id="0", storage_spec_code="dms.physical.storage.ultra.v2", ssl_enable=False, product_id="c6.4u8g.cluster", available_zones=listAvailableZonesbody, security_group_id="23c5977f-ff33-4b95-a73e-08d8a0bc4e6c", subnet_id="0a0f1fcb-f019-458d-b9e5-301867394d50", vpc_id="3db8490c-4d6d-4d8f-8d3f-047b0de4c5cf", storage_space=600, engine_version="4.8.0", engine="reliability", description="", name="reliability-1751840557" ) response = client.create_instance_by_engine(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] 创建一个RocketMQ实例，规格为4U8G\*1，600GB的存储空间，按需付费。 ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" rocketmq "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := rocketmq.RocketMQClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := rocketmq.NewRocketMQClient(hcClient) request := &model.CreateInstanceByEngineRequest{} request.Engine = model.GetCreateInstanceByEngineRequestEngineEnum().ENGINE var listAvailableZonesbody = []string{ "9f1c5806706d4c1fb0eb72f0a9b18c77", } publicipIdCreateInstanceByEngineReq:= "" diskEncryptedKeyCreateInstanceByEngineReq:= "********-b953-4875-a743-************" diskEncryptedEnableCreateInstanceByEngineReq:= true enablePublicipCreateInstanceByEngineReq:= false ipv6EnableCreateInstanceByEngineReq:= false enterpriseProjectIdCreateInstanceByEngineReq:= "0" sslEnableCreateInstanceByEngineReq:= false descriptionCreateInstanceByEngineReq:= "" request.Body = &model.CreateInstanceByEngineReq{ BrokerNum: int32(1), PublicipId: &publicipIdCreateInstanceByEngineReq, DiskEncryptedKey: &diskEncryptedKeyCreateInstanceByEngineReq, DiskEncryptedEnable: &diskEncryptedEnableCreateInstanceByEngineReq, EnablePublicip: &enablePublicipCreateInstanceByEngineReq, Ipv6Enable: &ipv6EnableCreateInstanceByEngineReq, EnterpriseProjectId: &enterpriseProjectIdCreateInstanceByEngineReq, StorageSpecCode: "dms.physical.storage.ultra.v2", SslEnable: &sslEnableCreateInstanceByEngineReq, ProductId: "c6.4u8g.cluster", AvailableZones: listAvailableZonesbody, SecurityGroupId: "23c5977f-ff33-4b95-a73e-08d8a0bc4e6c", SubnetId: "0a0f1fcb-f019-458d-b9e5-301867394d50", VpcId: "3db8490c-4d6d-4d8f-8d3f-047b0de4c5cf", StorageSpace: int32(600), EngineVersion: "4.8.0", Engine: "reliability", Description: &descriptionCreateInstanceByEngineReq, Name: "reliability-1751840557", } response, err := client.CreateInstanceByEngine(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/sdk?api=CreateInstanceByEngine)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 创建实例成功。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-hrm/ErrorCode.html)。