{"base_path":"/","components":null,"consumes":"[\"application/json\"]","definitions":{"BssParam":{"description":"表示包周期计费模式的相关参数。\n\n如果为空,则默认计费模式为按需计费;否则是包周期方式。","properties":{"charging_mode":{"description":"**参数解释**:\n计费模式。\n**约束限制**:\n不涉及。\n**取值范围**:\n- prePaid:预付费,即包年包月。\n- postPaid:后付费,即按需付费。\n**默认取值**:\npostPaid。","enum":["prePaid","postPaid"],"type":"string","x-no-support-region":"hcs"},"is_auto_pay":{"description":"**参数解释**:\n下单订购后,是否自动从客户的账户中支付,而不需要客户手动去进行支付。\n**约束限制**:\n不涉及。\n**取值范围**:\n- true:是(自动支付)\n- false:否(需要客户手动支付)\n**默认取值**:\nfalse","type":"boolean"},"is_auto_renew":{"description":"**参数解释**:\n是否自动续订。\n**约束限制**:\n不涉及。\n**取值范围**:\n- true:自动续订。\n- false:不自动续订。\n**默认取值**:\nfalse","type":"boolean"},"period_num":{"description":"**参数解释**:\n订购周期数。\n**约束限制**:\nchargingMode为prePaid时生效且为必选值。\n**取值范围**:\n- periodType=month(周期类型为月)时,取值为[1,9]。\n- periodType=year(周期类型为年)时,取值为[1,3]。\n**默认取值**:\n不涉及。","type":"integer"},"period_type":{"description":"**参数解释**:\n订购周期类型。\n**约束限制**:\nchargingMode为prePaid时生效且为必选值。\n**取值范围**:\n- month:月。\n- year:年。\n**默认取值**:\n不涉及。","enum":["month","year"],"type":"string"}},"type":"object","x-no-support-region":"hcs,dt"},"CreateInstanceReq":{"description":"创建实例请求体。","example":{"access_user":"******","available_zones":["d573142f24894ef3bd3664de068b44b0"],"broker_num":3,"description":"","enable_publicip":false,"engine":"RabbitMQ","engine_version":"3.8.35","maintain_begin":"22:00","maintain_end":"02:00","name":"rabbitmq-demo","password":"******","product_id":"00300-30109-0--0","publicip_id":"c6.4u8g.cluster","security_group_id":"0aaa0033-bf7f-4c41-a6c2-18cd04cad2c8","ssl_enable":false,"storage_space":100,"storage_spec_code":"dms.physical.storage.ultra.v2","subnet_id":"b5fa806c-35e7-4299-b659-b39398dd4718","vpc_id":"1e93f86e-13af-46c8-97d6-d40fa62b76c2"},"properties":{"access_user":{"description":"**参数解释**:\n 认证用户名。\n**约束限制**:\n只能由英文字母开头且由英文字母、数字、中划线、下划线组成,长度为4~64的字符。当ssl_enable为true时,该参数必选,ssl_enable为false时,该参数无效。\n**取值范围**:\n不涉及。\n**默认取值**:\n不涉及。","type":"string"},"available_zones":{"description":"**参数解释**:\n创建节点到指定且有资源的可用区ID。请参考[查询可用区信息](ListAvailableZones.xml)获取可用区ID。\n**约束限制**:\n该参数不能为空数组或者数组的值为空。\n\n创建RabbitMQ实例,节点需要部署在1个或3个及以上可用区中。如果部署在多个可用区中,以英文逗号隔开多个可用区ID。","items":{"description":"**参数解释**:\n可用区ID。\n**约束限制**:\n不涉及。\n**取值范围**:\n不涉及。\n**默认取值**:\n不涉及。","type":"string"},"type":"array"},"broker_num":{"description":"**参数解释**:\n代理个数。\n**约束限制**:\n当产品为单机类型,代理个数只能为1;当产品为集群类型,可选3、5、7个代理个数。\n**取值范围**:\n- 1\n- 3\n- 5\n- 7\n**默认取值**:\n不涉及。","enum":[1,3,5,7],"format":"int32","type":"integer"},"bss_param":{"$ref":"#/definitions/BssParam","description":"**参数解释**:\n表示包周期计费模式的相关参数。\n**约束限制**:\n不涉及。","x-no-support-region":"hcs,dt"},"description":{"description":"**参数解释**:\n实例的描述信息。\n**约束限制**:\n长度不超过1024的字符串。\n\n\\与\"在json报文中属于特殊字符,如果参数值中需要显示\\或者\"字符,请在字符前增加转义字符\\,比如\\\\\\\\或者\\\\\"。\n\n**取值范围**:\n不涉及。\n**默认取值**:\n不涉及。","type":"string"},"enable_acl":{"description":"**参数解释**:\nACL访问控制\n**约束限制**:\n仅AMQP版本支持此参数。\n**取值范围**:\n- true:开启ACL访问控制。\n- false:不开启ACL访问控制。\n**默认取值**:\n不涉及。","type":"boolean","x-no-support-region":"ctc,sbc,hk_sbc,g42,hk_g42,tm,hk_tm,hcs,dt,cmcc,ax"},"enable_publicip":{"description":"**参数解释**:\n是否开启公网访问功能。\n**约束限制**:\n不涉及。\n**取值范围**:\n- true:开启\n- false:不开启\n**默认取值**:\nfalse。","type":"boolean"},"engine":{"description":"**参数解释**:\n消息引擎。\n**约束限制**:\n不涉及\n**取值范围**:\nrabbitmq:RabbitMQ引擎。\n**默认取值**:\n不涉及。","enum":["rabbitmq"],"type":"string"},"engine_version":{"description":"**参数解释**:\n消息引擎的版本。\n**约束限制**:\n不涉及\n**取值范围**:\n- 3.8.35\n\n\n- AMQP-0-9-1\n**默认取值**:\n不涉及。","type":"string"},"enterprise_project_id":{"description":"**参数解释**:\n企业项目ID。\n**约束限制**:\n若为企业项目账号,该参数必填。\n**取值范围**:\n不涉及。\n**默认取值**:\n不涉及。","type":"string"},"maintain_begin":{"description":"**参数解释**:\n维护时间窗开始时间。\n**约束限制**:\n格式为HH:mm。\n**取值范围**:\n不涉及。\n**默认取值**:\n不涉及。","type":"string"},"maintain_end":{"description":"**参数解释**:\n维护时间窗结束时间。\n**约束限制**:\n格式为HH:mm。\n**取值范围**:\n不涉及。\n**默认取值**:\n不涉及。","type":"string"},"name":{"description":"**参数解释**:\n实例名称。\n**约束限制**:\n由英文字符开头,只能由英文字母、数字、中划线、下划线组成,长度为4~64的字符。\n**取值范围**:\n不涉及。\n**默认取值**:\n不涉及。","type":"string"},"password":{"description":"**参数解释**:\n实例的认证密码。\n**约束限制**:\n- 输入长度为8到32位的字符串。\n- 必须包含如下四种字符中的三种组合:\n - 小写字母\n - 大写字母\n - 数字\n - 特殊字符包括(`~!@#$%^&*()-_=+\\|[{}]:'\",<.>/?)和空格,并且不能以-开头\n- 当ssl_enable为true时,该参数必选,ssl_enable为false时,该参数无效。\n**取值范围**:\n不涉及。\n**默认取值**:\n不涉及。","type":"string"},"product_id":{"description":"**参数解释**:\n产品ID。产品ID可以从[查询产品规格列表](ListEngineProducts.xml)获取。\n**约束限制**:\n不涉及。\n**取值范围**:\n不涉及。\n**默认取值**:\n不涉及。","type":"string"},"publicip_id":{"description":"**参数解释**:\n实例绑定的弹性IP地址的ID。获取方法:参考[《弹性公网IP API参考》](https://support.huaweicloud.com/api-eip/ListPublicipsV3.html),调用“查询弹性公网IP列表”接口,从响应体中获取弹性公网IP的ID。\n**约束限制**:\n以英文逗号隔开多个弹性IP地址的ID。\n\n如果开启了公网访问功能(即enable_publicip为true),该字段为必选。\n**取值范围**:\n不涉及。\n**默认取值**:\n不涉及。","type":"string"},"security_group_id":{"description":"**参数解释**:\n指定实例所属的安全组。获取方法如下:参考[《虚拟私有云 API参考》](https://support.huaweicloud.com/api-vpc/vpc_apiv3_0011.html),调用“查询安全组列表”接口,从响应体中获取安全组ID。\n**约束限制**:\n不涉及。\n**取值范围**:\n不涉及。\n**默认取值**:\n不涉及。","type":"string"},"ssl_enable":{"description":"**参数解释**:\n是否开启SSL加密访问。\n**约束限制**:\n不涉及。\n**取值范围**:\n- true:开启SSL加密访问。\n- false:关闭SSL加密访问。\n**默认取值**:\n不涉及。","type":"boolean"},"storage_space":{"description":"**参数解释**:\n消息存储空间,单位GB。\n**约束限制**:\n磁盘容量仅支持设置为100的整数倍。\n**取值范围**:\n- 单机实例:100GB~30000GB。\n\n- 集群实例:100GB * 节点数 ~ 30000GB * 节点数。\n**默认取值**:\n不涉及。","type":"integer"},"storage_spec_code":{"description":"**参数解释**:\n存储IO规格。\n\n如何选择磁盘类型请参考[磁盘类型及性能介绍](https://support.huaweicloud.com/productdesc-evs/zh-cn_topic_0014580744.html)。\n\n\n**约束限制**:\n不涉及。\n**取值范围**:\n- dms.physical.storage.high.v2:高IO云硬盘。\n- dms.physical.storage.ultra.v2:超高IO云硬盘。\n- dms.physical.storage.general:通用型SSD云硬盘。\n- dms.physical.storage.extreme:极速型SSD云硬盘。\n**默认取值**:\n不涉及。","enum":["dms.physical.storage.high.v2","dms.physical.storage.ultra.v2","[dms.physical.storage.general](tag:hws,hws_hk,dt,ax)","[dms.physical.storage.extreme](tag:hws,hws_hk,dt,ax)"],"type":"string"},"subnet_id":{"description":"**参数解释**:\n子网信息。获取方法如下:参考[《虚拟私有云 API参考》](https://support.huaweicloud.com/api-vpc/vpc_subnet01_0003.html),调用“查询子网列表”接口,从响应体中获取子网ID。\n**约束限制**:\n不涉及。\n**取值范围**:\n不涉及。\n**默认取值**:\n不涉及。","type":"string"},"tags":{"description":"**参数解释**:\n标签列表。\n**约束限制**:\n一个RabbitMQ实例最多添加20个标签。","items":{"$ref":"#/definitions/TagEntity"},"type":"array"},"vpc_id":{"description":"**参数解释**:\n 虚拟私有云ID。获取方法如下:参考[《虚拟私有云 API参考》](https://support.huaweicloud.com/api-vpc/vpc_apiv3_0003.html),调用“查询VPC列表”接口,从响应体中获取VPC ID。\n**约束限制**:\n不涉及。\n**取值范围**:\n不涉及。\n**默认取值**:\n不涉及。","type":"string"}},"required":["name","engine","engine_version","storage_space","vpc_id","security_group_id","subnet_id","available_zones","product_id","storage_spec_code"],"type":"object"},"CreateInstanceResp":{"properties":{"instance_id":{"description":"**参数解释**:\n实例ID。\n**取值范围**:\n不涉及。","type":"string"}},"type":"object"},"TagEntity":{"properties":{"key":{"description":"**参数解释**:\n标签键。\n**约束限制**:\n- 不能为空。\n\n- 对于同一个实例,Key值唯一。\n\n- 长度为1~128个字符(中文也可以输入128个字符)。\n\n- 由任意语种字母、数字、空格和字符组成,字符仅支持_ . : = + - @\n\n- 不能以_sys_开头。\n\n- 首尾字符不能为空格。\n**取值范围**:\n不涉及。\n**默认取值**:\n不涉及。","type":"string"},"value":{"description":"**参数解释**:\n标签值。\n**约束限制**:\n- 长度为0~255个字符(中文也可以输入255个字符)。\n\n- 由任意语种字母、数字、空格和字符组成,字符仅支持_ . : = + - @\n**取值范围**:\n不涉及。\n**默认取值**:\n不涉及。","type":"string"}},"type":"object"}},"description":null,"group_id":"01d11699e8074781a7ab0fb1c8d994e7","host":"dms.cn-north-4.myhuaweicloud.com","id":"2918a70219e24596bb1a6bd18b0edc67","info_version":"v2","method":"post","name":"CreatePostPaidInstanceByEngine","parameters":{},"paths":{"/v2/{engine}/{project_id}/instances":{"post":{"description":"创建实例,该接口支持创建按需和包周期计费方式的实例。","operationId":"CreatePostPaidInstanceByEngine","parameters":[{"default":"rabbitmq","description":"**参数解释**:\n消息引擎。\n**约束限制**:\n不涉及。\n**取值范围**:\nrabbitmq:RabbitMQ引擎。\n**默认取值**:\n不涉及。","enum":["rabbitmq"],"in":"path","name":"engine","required":true,"type":"string","x-order":1},{"description":"**参数解释**:\n项目ID,获取方式请参见[获取项目ID](rabbitmq-api-190611012.xml)。\n**约束限制**:\n不涉及。\n**取值范围**:\n不涉及。\n**默认取值**:\n不涉及。","in":"path","name":"project_id","required":true,"type":"string","x-example":"2b31ed520xxxxxxebedb6e57xxxxxxxx","x-order":2},{"description":"请求消息。","in":"body","name":"CreatePostPaidInstanceByEngineRequestBody","required":true,"schema":{"$ref":"#/definitions/CreateInstanceReq"},"x-order":3}],"responses":{"200":{"description":"创建实例成功。","examples":{"application/json":{"instance_id":"8959ab1c-7n1a-yyb1-a05t-93dfc361b32d"}},"schema":{"$ref":"#/definitions/CreateInstanceResp"}}},"summary":"创建实例","tags":["生命周期管理"],"x-api-type":"open-api","x-hybridcloud":true,"x-is-registered":"Y","x-name":"创建实例(按需)","x-open-region-cloud":"hws,hws_eu,hws_hk,g42,hk_g42,tm,hk_tm,ctc,hcs,sbc,cmcc,ax,hk_sbc,dt","x-order":1,"x-produc-type":"rabbitmq","x-request-examples-1":{"access_user":"******","available_zones":["d573142f24894ef3bd3664de068b44b0"],"description":"","enable_publicip":false,"engine":"RabbitMQ","engine_version":"3.8.35","name":"rabbitmq-demo","password":"******","product_id":"c6.2u4g.single","publicip_id":"","security_group_id":"0aaa0033-bf7f-4c41-a6c2-18cd04cad2c8","ssl_enable":false,"storage_space":100,"storage_spec_code":"dms.physical.storage.high.v2","subnet_id":"b5fa806c-35e7-4299-b659-b39398dd4718","vpc_id":"1e93f86e-13af-46c8-97d6-d40fa62b76c2"},"x-request-examples-2":{"access_user":"******","available_zones":["d573142f24894ef3bd3664de068b44b0"],"bss_param":{"charging_mode":"prePaid","is_auto_pay":true,"period_num":1,"period_type":"month"},"description":"","enable_publicip":false,"engine":"RabbitMQ","engine_version":"3.8.35","name":"rabbitmq-demo","password":"******","product_id":"c6.2u4g.single","publicip_id":"","security_group_id":"0aaa0033-bf7f-4c41-a6c2-18cd04cad2c8","ssl_enable":false,"storage_space":100,"storage_spec_code":"dms.physical.storage.high.v2","subnet_id":"b5fa806c-35e7-4299-b659-b39398dd4718","vpc_id":"1e93f86e-13af-46c8-97d6-d40fa62b76c2"},"x-request-examples-3":{"access_user":"******","available_zones":["d573142f24894ef3bd3664de068b44b0"],"description":"","enable_publicip":false,"engine":"RabbitMQ","engine_version":"3.8.35","name":"rabbitmq-demo","password":"******","product_id":"c6.4u16g.cluster.x86","publicip_id":"","security_group_id":"0aaa0033-bf7f-4c41-a6c2-18cd04cad2c8","ssl_enable":false,"storage_space":300,"storage_spec_code":"dms.physical.storage.high.v2","subnet_id":"b5fa806c-35e7-4299-b659-b39398dd4718","vpc_id":"1e93f86e-13af-46c8-97d6-d40fa62b76c2"},"x-request-examples-4":{"available_zones":["9f1c5806706d4c1fb0eb72f0a9b18c77"],"broker_num":1,"description":"","enable_acl":true,"enable_publicip":false,"engine":"RabbitMQ","engine_version":"AMQP-0-9-1","enterprise_project_id":0,"name":"rabbitmq-aor-demo","product_id":"amqp.b1.large.1","security_group_id":"030f635d-b407-4ffb-b530-6b4eaf8edc03","ssl_enable":false,"storage_space":100,"storage_spec_code":"dms.physical.storage.high.v2","subnet_id":"89c1cb26-787b-4d66-a6e4-1bd887f19183","vpc_id":"05590544-f553-4158-be38-c791589ad303"},"x-request-examples-5":{"access_user":"******","available_zones":["d573142f24894ef3bd3664de068b44b0"],"description":"","enable_publicip":false,"engine":"RabbitMQ","engine_version":"3.13.7","name":"rabbitmq-demo","password":"******","product_id":"c6.2u4g.single","publicip_id":"","security_group_id":"0aaa0033-bf7f-4c41-a6c2-18cd04cad2c8","ssl_enable":false,"storage_space":100,"storage_spec_code":"dms.physical.storage.high.v2","subnet_id":"b5fa806c-35e7-4299-b659-b39398dd4718","vpc_id":"1e93f86e-13af-46c8-97d6-d40fa62b76c2"},"x-request-examples-description-1":"创建一个按需付费的RabbitMQ实例,版本为3.8.35,规格为2U4G*1,100GB的存储空间。","x-request-examples-description-2":"创建一个包年包月的RabbitMQ实例,版本为3.8.35,规格为2U4G*1,100GB的存储空间。","x-request-examples-description-3":"创建一个RabbitMQ实例,版本为3.8.35,规格为4U16G*3,300GB的存储空间。","x-request-examples-description-4":"创建一个RabbitMQ实例,版本为AMQP-0-9-1,规格为amqp.b1.large.1,100GB的存储空间。","x-request-examples-description-5":"创建一个按需付费的RabbitMQ实例,版本为3.13.7,规格为2U4G*1,100GB的存储空间。","x-request-examples-tags-1":"hws,hws_eu,hws_hk,ctc,g42,hk_g42,tm,hk_tm,sbc,ax,hk_sbc","x-request-examples-tags-2":"hws,hws_eu,hws_hk,ocb,hws_ocb,ctc,g42,hk_g42,tm,hk_tm,ax","x-request-examples-tags-3":"hcs","x-request-examples-tags-4":"hws,hws_hk,hws_eu","x-request-examples-tags-5":"dt","x-request-examples-url-1":"POST https://{endpoint}/v2/{engine}/{project_id}/instances","x-request-examples-url-2":"POST https://{endpoint}/v2/{engine}/{project_id}/instances","x-request-examples-url-3":"POST https://{endpoint}/v2/{engine}/{project_id}/instances","x-request-examples-url-4":"POST https://{endpoint}/v2/{engine}/{project_id}/instances","x-request-examples-url-5":"POST https://{endpoint}/v2/{engine}/{project_id}/instances","x-support-sdk":"Y"}}},"product_short":"RabbitMQ","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"创建实例","tags":"生命周期管理","uri":null,"version":"2.0"}