{"base_path":"/","components":null,"consumes":"[\"application/json\"]","definitions":{"ListInstancesResp":{"properties":{"instance_num":{"description":"**参数解释**:\n实例个数。\n**取值范围**:\n不涉及。","type":"integer"},"instances":{"description":"**参数解释**:\n实例列表。","items":{"$ref":"#/definitions/ShowInstanceResp"},"type":"array"}},"type":"object"},"ShowInstanceResp":{"properties":{"access_user":{"description":"**参数解释**:\n认证用户名。\n**取值范围**:\n不涉及。","type":"string"},"available_zone_names":{"description":"**参数解释**:\n实例节点所在的可用区名称。","items":{"description":"**参数解释**:\n可用区名称。。\n**取值范围**:\n不涉及。","type":"string"},"type":"array"},"available_zones":{"description":"**参数解释**:\n实例节点所在的可用区ID。","items":{"description":"**参数解释**:\n可用区ID。\n**取值范围**:\n不涉及。","type":"string"},"type":"array"},"broker_num":{"description":"**参数解释**:\n代理个数。\n**取值范围**:\n- 1\n- 3\n- 5\n- 7","enum":[1,3,5,7],"format":"int32","type":"integer"},"charging_mode":{"description":"**参数解释**:\n付费模式。\n**取值范围**:\n- 1:按需计费。\n- 0:包年/包月计费。","type":"integer","x-no-support-region":"hcs"},"connect_address":{"description":"**参数解释**:\n实例内网连接IP地址。\n**取值范围**:\n不涉及。","type":"string"},"connect_domain_name":{"description":"**参数解释**:\n实例内网连接域名。\n**取值范围**:\n不涉及。","type":"string"},"created_at":{"description":"**参数解释**:\n完成创建时间。格式为时间戳,指从格林威治时间 1970年01月01日00时00分00秒起至指定时间的偏差总毫秒数。\n**取值范围**:\n不涉及。","type":"string"},"description":{"description":"**参数解释**:\n实例描述。\n**取值范围**:\n不涉及。","type":"string"},"dns_enable":{"description":"**参数解释**:\n实例是否开启域名访问功能。\n**取值范围**:\n- true:开启\n- false:未开启","type":"boolean"},"enable_publicip":{"description":"**参数解释**:\nRabbitMQ实例是否开启公网访问功能。\n**取值范围**:\n- true:开启\n- false:未开启","type":"boolean"},"engine":{"description":"**参数解释**:\n消息引擎。\n**取值范围**:\n不涉及。","type":"string"},"engine_version":{"description":"**参数解释**:\n消息引擎版本。\n**取值范围**:\n不涉及。","type":"string"},"enterprise_project_id":{"description":"**参数解释**:\n企业项目ID。\n**取值范围**:\n不涉及。","type":"string"},"extend_times":{"description":"**参数解释**:\n实例扩容磁盘次数,如果超过20次则无法扩容磁盘。\n**取值范围**:\n不涉及。","type":"integer"},"instance_id":{"description":"**参数解释**:\n实例ID。\n**取值范围**:\n不涉及。","type":"string"},"ipv6_connect_addresses":{"description":"**参数解释**:\nIPv6的连接地址。","items":{"type":"string"},"type":"array"},"ipv6_enable":{"description":"**参数解释**:\n是否开启IPv6。\n**取值范围**:\n- true:开启。\n- false:不开启。","type":"boolean"},"is_logical_volume":{"description":"**参数解释**:\n实例扩容时用于区分老实例与新实例。\n**取值范围**:\n- true:新创建的实例,允许磁盘动态扩容不需要重启。\n- false:特别老的实例不支持磁盘扩容。","type":"boolean"},"maintain_begin":{"description":"**参数解释**:\n维护时间窗开始时间,格式为HH:mm:ss。\n**取值范围**:\n不涉及。","type":"string"},"maintain_end":{"description":"**参数解释**:\n维护时间窗结束时间,格式为HH:mm:ss。\n**取值范围**:\n不涉及。","type":"string"},"management_connect_address":{"description":"**参数解释**:\nRabbitMQ实例的管理地址。\n**取值范围**:\n不涉及。","type":"string"},"management_connect_domain_name":{"description":"**参数解释**:\nRabbitMQ实例的管理域名。\n**取值范围**:\n不涉及。","type":"string"},"name":{"description":"**参数解释**:\n实例名称。\n**取值范围**:\n不涉及。","type":"string"},"order_id":{"description":"**参数解释**:\n订单ID,只有在包周期计费时才会有order_id值,其他计费方式order_id值为空。\n**取值范围**:\n不涉及。","type":"string","x-no-support-region":"hcs"},"port":{"description":"**参数解释**:\n实例连接端口。\n**取值范围**:\n不涉及。","type":"integer"},"product_id":{"description":"**参数解释**:\n产品标识。\n**取值范围**:\n不涉及。","type":"string"},"public_connect_address":{"description":"**参数解释**:\n实例公网连接IP地址。\n**取值范围**:\n不涉及。","type":"string"},"public_connect_domain_name":{"description":"**参数解释**:\n实例公网连接域名。\n**取值范围**:\n不涉及。","type":"string"},"public_management_connect_address":{"description":"**参数解释**:\nRabbitMQ实例的公网管理地址。\n**取值范围**:\n不涉及。","type":"string"},"public_management_connect_domain_name":{"description":"**参数解释**:\nRabbitMQ实例的公网管理域名。\n**取值范围**:\n不涉及。","type":"string"},"publicip_address":{"description":"**参数解释**:\nRabbitMQ实例绑定的弹性IP地址。\n\n如果未开启公网访问功能,该字段值为null。\n**取值范围**:\n- true:开启\n- false:未开启","type":"string"},"publicip_id":{"description":"**参数解释**:\nRabbitMQ实例绑定的弹性IP地址的ID。\n\n如果未开启公网访问功能,该字段值为null。\n**取值范围**:\n不涉及。","type":"string"},"resource_spec_code":{"description":"**参数解释**:\n资源规格标识。\n**取值范围**:\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":"**参数解释**:\n安全组ID。\n**取值范围**:\n不涉及。","type":"string"},"security_group_name":{"description":"**参数解释**:\n租户安全组名称。\n**取值范围**:\n不涉及。","type":"string"},"specification":{"description":"**参数解释**:\n实例规格。\n**取值范围**:\n- 单机实例:返回vm规格。\n- 集群实例:返回vm规格和节点数。","type":"string"},"ssl_enable":{"description":"**参数解释**:\n是否开启安全认证。\n**取值范围**:\n- true:开启\n- false:未开启","type":"boolean"},"status":{"description":"**参数解释**:\n实例状态。\n**取值范围**:\n详细状态说明请参考[实例状态说明](rabbitmq-api-180514012.xml)。","type":"string"},"storage_resource_id":{"description":"**参数解释**:\n存储资源ID。\n**取值范围**:\n不涉及。","type":"string"},"storage_space":{"description":"**参数解释**:\n消息存储空间,单位:GB。\n**取值范围**:\n不涉及。","type":"integer"},"storage_spec_code":{"description":"**参数解释**:\nIO规格。\n**取值范围**:\n不涉及。","type":"string"},"subnet_id":{"description":"**参数解释**:\n子网ID。\n**取值范围**:\n不涉及。","type":"string"},"tags":{"description":"**参数解释**:\n标签列表。","items":{"$ref":"#/definitions/TagEntity"},"type":"array","x-no-support-region":"hcs"},"total_storage_space":{"description":"**参数解释**:\n总共消息存储空间,单位:GB。\n**取值范围**:\n不涉及。","type":"integer"},"type":{"description":"**参数解释**:\n实例类型。\n**取值范围**:\n- single:单机。\n- cluster:集群。","enum":["single","cluster"],"type":"string"},"used_storage_space":{"description":"**参数解释**:\n已使用的消息存储空间,单位:GB。\n**取值范围**:\n不涉及。","type":"integer"},"user_id":{"description":"**参数解释**:\n用户ID。\n**取值范围**:\n不涉及。","type":"string"},"user_name":{"description":"**参数解释**:\n用户名。\n**取值范围**:\n不涉及。","type":"string"},"vpc_id":{"description":"**参数解释**:\nVPC ID。\n**取值范围**:\n不涉及。","type":"string"},"vpc_name":{"description":"**参数解释**:\nVPC的名称。\n**取值范围**:\n不涉及。","type":"string"}},"type":"object"},"TagEntity":{"properties":{"key":{"description":"**参数解释**:\n标签键。\n**取值范围**:\n不涉及。","type":"string"},"value":{"description":"**参数解释**:\n标签值。\n**取值范围**:\n不涉及。","type":"string"}},"type":"object"}},"description":null,"group_id":"01d11699e8074781a7ab0fb1c8d994e7","host":"dms.cn-north-4.myhuaweicloud.com","id":"3df0f996f85d471e84dd5c3a3243b938","info_version":"v2","method":"get","name":"ListInstancesDetails","parameters":{},"paths":{"/v2/{project_id}/instances":{"get":{"description":"查询租户的实例列表,支持按照条件查询。","operationId":"ListInstancesDetails","parameters":[{"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":1},{"default":"rabbitmq","description":"**参数解释**:\n引擎类型:rabbitmq。\n**约束限制**:\n不涉及。\n**取值范围**:\n不涉及。\n**默认取值**:\n不涉及。","enum":["rabbitmq"],"in":"query","name":"engine","required":true,"type":"string","x-order":2},{"description":"**参数解释**:\n实例名称。获取方式:登录RabbitMQ控制台,在RabbitMQ实例详情页面查找实例名称。\n**约束限制**:\n不涉及。\n**取值范围**:\n不涉及。\n**默认取值**:\n不涉及。","in":"query","name":"name","required":false,"type":"string","x-order":3},{"description":"**参数解释**:\n实例ID。获取方法如下:登录RabbitMQ控制台,在RabbitMQ实例详情页面查找实例ID。\n**约束限制**:\n不涉及。\n**取值范围**:\n不涉及。\n**默认取值**:\n不涉及。","in":"query","name":"instance_id","required":false,"type":"string","x-order":4},{"description":"**参数解释**:\n实例状态,详细状态说明请参考[实例状态说明](rabbitmq-api-180514012.xml)。\n**约束限制**:\n不涉及。\n**取值范围**:\n不涉及。\n**默认取值**:\n不涉及。","enum":["CREATING","RUNNING","RESTARTING","DELETING","ERROR","CREATEFAILED","FREEZING","FROZEN","EXTENDING","SHRINKING","EXTENDEDFAILED","CONFIGURING","ROLLBACK","ROLLBACKFAILED","VOLUMETYPECHANGING"],"in":"query","name":"status","required":false,"type":"string","x-order":5},{"description":"**参数解释**:\n是否返回创建失败的实例数。\n**约束限制**:\n不涉及。\n**取值范围**:\n- true:返回创建失败的实例数。\n- false:不返回创建失败的实例数。\n\n**默认取值**:\n不涉及。","enum":["true","false"],"in":"query","name":"include_failure","required":false,"type":"string","x-order":6},{"description":"**参数解释**:\n是否按照实例名称进行精确匹配查询。\n**约束限制**:\n不涉及。\n**取值范围**:\n- true:按照实例名称进行精确匹配查询。\n- false:按照模糊匹配实例名称查询。\n\n**默认取值**:\nfalse","enum":["true","false"],"in":"query","name":"exact_match_name","required":false,"type":"string","x-order":7},{"description":"**参数解释**:\n企业项目ID。\n**约束限制**:\n不涉及。\n**取值范围**:\n不涉及。\n**默认取值**:\n不涉及。","in":"query","name":"enterprise_project_id","required":false,"type":"string","x-order":8},{"description":"**参数解释**:\n偏移量,表示从此偏移量开始查询。\n**约束限制**:\n不涉及。\n**取值范围**:\n大于等于0\n**默认取值**:\n不涉及。","in":"query","name":"offset","required":false,"type":"string","x-order":9},{"description":"**参数解释**:\n当次查询返回的最大实例个数。\n**约束限制**:\n不涉及。\n**取值范围**:\n1~50\n**默认取值**:\n10","in":"query","name":"limit","required":false,"type":"string","x-order":10}],"responses":{"200":{"description":"查询所有实例列表成功。","examples":{"application/json":{"instance_num":1,"instances":[{"available_zone_names":["AZ1"],"available_zones":["9f1c5806706d4c1fb0eb72f0a9b18c77"],"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":"********","vpc_id":"40a6501e-85ca-4449-a0db-b8bc7f0cec28","vpc_name":"vpc-a400"}]}},"schema":{"$ref":"#/definitions/ListInstancesResp"}}},"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,ctc,sbc,hk_sbc,g42,hk_g42,tm,hk_tm,hcs,cmcc","x-order":2,"x-produc-type":"rabbitmq","x-request-examples-description-1":"查询所有实例列表。","x-request-examples-url-1":"GET https://{endpoint}/v2/{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"}