huawei-cloud-api-definitions-RabbitMQ 0.1.20240201

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json\"]","definitions":{"ShowInstanceResp":{"properties":{"access_user":{"description":"认证用户名,只能由英文字母、数字、中划线组成,长度为4~64的字符。","type":"string"},"available_zones":{"description":"实例节点所在的可用区,返回“可用区ID”。","items":{"description":"可用区ID。","type":"string"},"type":"array"},"broker_num":{"description":"代理个数。","enum":[1,3,5,7],"format":"int32","type":"integer"},"charging_mode":{"description":"付费模式,1表示按需计费,0表示包年/包月计费。","type":"integer"},"connect_address":{"description":"实例连接IP地址。","type":"string"},"created_at":{"description":"完成创建时间。格式为时间戳,指从格林威治时间 1970年01月01日00时00分00秒起至指定时间的偏差总毫秒数。","type":"string"},"description":{"description":"实例描述。","type":"string"},"enable_publicip":{"description":"RabbitMQ实例是否开启公网访问功能。\n  - true:开启\n  - false:未开启","type":"boolean"},"engine":{"description":"消息引擎。","type":"string"},"engine_version":{"description":"消息引擎版本。","type":"string"},"enterprise_project_id":{"description":"企业项目ID。","type":"string"},"extend_times":{"description":"实例扩容磁盘次数,如果超过20次则无法扩容磁盘。","type":"integer"},"instance_id":{"description":"实例ID。","type":"string"},"ipv6_connect_addresses":{"description":"IPv6的连接地址。","items":{"type":"string"},"type":"array"},"ipv6_enable":{"description":"是否开启ipv6。","type":"boolean"},"is_logical_volume":{"description":"实例扩容时用于区分老实例与新实例。\n- true:新创建的实例,允许磁盘动态扩容不需要重启。\n- false:老实例","type":"boolean"},"maintain_begin":{"description":"维护时间窗开始时间,格式为HH:mm:ss。","type":"string"},"maintain_end":{"description":"维护时间窗结束时间,格式为HH:mm:ss。","type":"string"},"management_connect_address":{"description":"RabbitMQ实例的管理地址。","type":"string"},"name":{"description":"实例名称。","type":"string"},"order_id":{"description":"订单ID,只有在包周期计费时才会有order_id值,其他计费方式order_id值为空。","type":"string"},"port":{"description":"实例连接端口。","type":"integer"},"product_id":{"description":"产品标识。","type":"string"},"publicip_address":{"description":"RabbitMQ实例绑定的弹性IP地址。\n\n如果未开启公网访问功能,该字段值为null。","type":"string"},"publicip_id":{"description":"RabbitMQ实例绑定的弹性IP地址的ID。\n\n如果未开启公网访问功能,该字段值为null。","type":"string"},"resource_spec_code":{"description":"资源规格标识。\n  - dms.instance.rabbitmq.single.c3.2u4g:RabbitMQ单机,vm规格2u4g\n  - dms.instance.rabbitmq.single.c3.4u8g:RabbitMQ单机,vm规格4u8g\n  - dms.instance.rabbitmq.single.c3.8u16g:RabbitMQ单机,vm规格8u16g\n  - dms.instance.rabbitmq.single.c3.16u32g:RabbitMQ单机,vm规格16u32g\n  - dms.instance.rabbitmq.cluster.c3.4u8g.3:RabbitMQ集群,vm规格4u8g,3个节点\n  - dms.instance.rabbitmq.cluster.c3.4u8g.5:RabbitMQ集群,vm规格4u8g,5个节点\n  - dms.instance.rabbitmq.cluster.c3.4u8g.7:RabbitMQ集群,vm规格4u8g,7个节点\n  - dms.instance.rabbitmq.cluster.c3.8u16g.3:RabbitMQ集群,vm规格8u16g,3个节点\n  - dms.instance.rabbitmq.cluster.c3.8u16g.5:RabbitMQ集群,vm规格8u16g,5个节点\n  - dms.instance.rabbitmq.cluster.c3.8u16g.7:RabbitMQ集群,vm规格8u16g,7个节点\n  - dms.instance.rabbitmq.cluster.c3.16u32g.3:RabbitMQ集群,vm规格16u32g,3个节点\n  - dms.instance.rabbitmq.cluster.c3.16u32g.5:RabbitMQ集群,vm规格16u32g,5个节点\n  - dms.instance.rabbitmq.cluster.c3.16u32g.7:RabbitMQ集群,vm规格16u32g,7个节点","type":"string"},"security_group_id":{"description":"安全组ID。","type":"string"},"security_group_name":{"description":"租户安全组名称。","type":"string"},"specification":{"description":"实例规格。\n  - RabbitMQ实例单机返回vm规格。\n  - RabbitMQ实例集群返回vm规格和节点数。","type":"string"},"ssl_enable":{"description":"是否开启安全认证。\n  - true:开启\n  - false:未开启","type":"boolean"},"status":{"description":"实例的状态。","type":"string"},"storage_resource_id":{"description":"存储资源ID。","type":"string"},"storage_space":{"description":"消息存储空间,单位:GB。","type":"integer"},"storage_spec_code":{"description":"IO规格。","type":"string"},"subnet_id":{"description":"子网ID。","type":"string"},"tags":{"description":"标签列表。","items":{"$ref":"#/definitions/TagEntity"},"type":"array"},"total_storage_space":{"description":"总共消息存储空间,单位:GB。","type":"integer"},"type":{"description":"实例类型:集群,cluster。","enum":["single","cluster"],"type":"string"},"used_storage_space":{"description":"已使用的消息存储空间,单位:GB。","type":"integer"},"user_id":{"description":"用户ID。","type":"string"},"user_name":{"description":"用户名。","type":"string"},"vpc_id":{"description":"VPC ID。","type":"string"},"vpc_name":{"description":"VPC的名称。","type":"string"}},"type":"object"},"TagEntity":{"properties":{"key":{"description":"标签键。\n\n- 不能为空。\n\n- 对于同一个实例,Key值唯一。\n\n\n\n- 长度为1~128个字符(中文也可以输入128个字符)。\n\n\n\n- 由任意语种字母、数字、空格和字符组成,字符仅支持_ . : = + - @\n\n- 首尾字符不能为空格。","type":"string"},"value":{"description":"标签值。\n\n\n\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":"1a2d196776b741a7a3cda0ae155bba52","info_version":"v2","method":"get","name":"ShowInstance","parameters":{},"paths":{"/v2/{project_id}/instances/{instance_id}":{"get":{"description":"查询指定实例的详细信息。","operationId":"ShowInstance","parameters":[{"description":"项目ID,获取方式请参见[获取项目ID](rabbitmq-api-190611012.xml)。","in":"path","name":"project_id","required":true,"type":"string","x-example":"2b31ed520xxxxxxebedb6e57xxxxxxxx","x-order":1},{"description":"实例ID。","in":"path","name":"instance_id","required":true,"type":"string"}],"responses":{"200":{"description":"查询指定实例成功。","examples":{"application/json":{"access_user":"root_01","available_zones":["9f1c5806706d4c1fb0eb72f0a9b18c77"],"broker_num":1,"charging_mode":1,"connect_address":"192.168.0.74","created_at":"1590047080687","enable_publicip":false,"engine":"rabbitmq","engine_version":"3.8.35","enterprise_project_id":"0","extend_times":0,"instance_id":"de873040-d661-4770-aa96-9329c71d7c8a","ipv6_connect_addresses":[],"ipv6_enable":false,"is_logical_volume":true,"maintain_begin":"22:00:00","maintain_end":"02:00:00","management_connect_address":"http://192.168.0.74:15672","name":"api-explorer","port":5672,"product_id":"00300-30109-0--0","resource_spec_code":"dms.instance.rabbitmq.single.c3.2u4g","security_group_id":"bfd68e26-f8ef-4a91-a373-0a8f5c198601","security_group_name":"Sys-default","specification":"2vCPUs 4GB","ssl_enable":false,"status":"RUNNING","storage_resource_id":"52be287d-1d6a-4d30-937e-185b3f176fc4","storage_space":88,"storage_spec_code":"dms.physical.storage.normal","subnet_id":"a7f9a564-30dd-4059-8124-364ca6554578","tags":[{"key":"key1","value":"value1"},{"key":"key2","value":"value2"}],"total_storage_space":100,"type":"single","used_storage_space":4,"user_id":"3df5acbc24a54fadb62a043c9000a307","user_name":"paas_dms_pwx483199_01","vpc_id":"40a6501e-85ca-4449-a0db-b8bc7f0cec28","vpc_name":"vpc-a400"}},"schema":{"$ref":"#/definitions/ShowInstanceResp"}}},"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,ocb,hws_ocb,ctc,sbc,hk_sbc,g42,hk_g42,tm,hk_tm","x-order":3,"x-produc-type":"rabbitmq","x-request-examples-description-1":"查询指定实例的详细信息。","x-request-examples-url-1":"GET https://{endpoint}/v2/{project_id}/instances/{instance_id}","x-support-sdk":"Y"}}},"product_short":"RabbitMQ","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询指定实例","tags":"生命周期管理","uri":null,"version":"2.0"}