创建实例
功能介绍
创建实例,该接口支持创建按需和包周期两种计费方式的实例。
调用方法
请参见如何调用API。
URI
POST /v2/{engine}/{project_id}/instances
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
engine |
是 |
String |
消息引擎。 |
project_id |
是 |
String |
项目ID,获取方式请参见获取项目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。 获取方法如下:登录虚拟私有云服务的控制台界面,在虚拟私有云的详情页面查找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时生效且为必选值。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
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, "publicip_id" : "", "broker_num" : 1 }
响应示例
状态码: 200
创建实例成功。
{ "instance_id" : "8959ab1c-7n1a-yyb1-a05t-93dfc361b32d" }
SDK代码示例
SDK代码示例如下。
创建一个RocketMQ实例,规格为4U8G*1,600GB的存储空间,按需付费。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 |
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("<YOUR REGION>")) .build(); CreateInstanceByEngineRequest request = new CreateInstanceByEngineRequest(); request.withEngine(CreateInstanceByEngineRequest.EngineEnum.fromValue("{engine}")); CreateInstanceByEngineReq body = new CreateInstanceByEngineReq(); List<String> listbodyAvailableZones = new ArrayList<>(); listbodyAvailableZones.add("9f1c5806706d4c1fb0eb72f0a9b18c77"); body.withBrokerNum(1); body.withPublicipId(""); body.withEnablePublicip(false); body.withIpv6Enable(false); body.withEnterpriseProjectId("0"); body.withStorageSpecCode(CreateInstanceByEngineReq.StorageSpecCodeEnum.fromValue("dms.physical.storage.ultra.v2")); body.withSslEnable(false); body.withProductId(CreateInstanceByEngineReq.ProductIdEnum.fromValue("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(CreateInstanceByEngineReq.EngineVersionEnum.fromValue("4.8.0")); body.withEngine(CreateInstanceByEngineReq.EngineEnum.fromValue("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()); } } } |
创建一个RocketMQ实例,规格为4U8G*1,600GB的存储空间,按需付费。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
# 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("<YOUR REGION>")) \ .build() try: request = CreateInstanceByEngineRequest() request.engine = "{engine}" listAvailableZonesbody = [ "9f1c5806706d4c1fb0eb72f0a9b18c77" ] request.body = CreateInstanceByEngineReq( broker_num=1, publicip_id="", 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) |
创建一个RocketMQ实例,规格为4U8G*1,600GB的存储空间,按需付费。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 |
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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := rocketmq.NewRocketMQClient( rocketmq.RocketMQClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateInstanceByEngineRequest{} request.Engine = model.GetCreateInstanceByEngineRequestEngineEnum().ENGINE var listAvailableZonesbody = []string{ "9f1c5806706d4c1fb0eb72f0a9b18c77", } publicipIdCreateInstanceByEngineReq:= "" enablePublicipCreateInstanceByEngineReq:= false ipv6EnableCreateInstanceByEngineReq:= false enterpriseProjectIdCreateInstanceByEngineReq:= "0" sslEnableCreateInstanceByEngineReq:= false descriptionCreateInstanceByEngineReq:= "" request.Body = &model.CreateInstanceByEngineReq{ BrokerNum: int32(1), PublicipId: &publicipIdCreateInstanceByEngineReq, EnablePublicip: &enablePublicipCreateInstanceByEngineReq, Ipv6Enable: &ipv6EnableCreateInstanceByEngineReq, EnterpriseProjectId: &enterpriseProjectIdCreateInstanceByEngineReq, StorageSpecCode: model.GetCreateInstanceByEngineReqStorageSpecCodeEnum().DMS_PHYSICAL_STORAGE_ULTRA, SslEnable: &sslEnableCreateInstanceByEngineReq, ProductId: model.GetCreateInstanceByEngineReqProductIdEnum().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: model.GetCreateInstanceByEngineReqEngineVersionEnum().E_4_8_0, Engine: model.GetCreateInstanceByEngineReqEngineEnum().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的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
创建实例成功。 |
错误码
请参见错误码。