# 查询MQS实例详情 - ShowMqsInstance #### 功能介绍 查询指定MQS实例详情。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ROMA/doc?api=ShowMqsInstance)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-roma/roma_06_0018.html)。 #### URI GET /v2/{project_id}/mqs/instances/{instance_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取方式请参见API参考的"附录 \> 获取项目ID"章节。 | | instance_id | 是 | String | 实例ID。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | 实例名称。 | | engine | String | 引擎。 | | status | String | 实例的状态。 - CREATING: 申请实例后，在实例状态进入运行中之前的状态。 - RUNNING: 实例正常运行状态。在这个状态的实例可以运行您的业务。 | | description | String | 描述信息。 | | type | String | 实例类型：集群，cluster。 | | specification | String | 实例规格。 | | engine_version | String | 版本。 | | instance_id | String | 实例ID。 | | resource_spec_code | String | 资源规格标识。 - dms.instance.kafka.cluster.c3.mini：Kafka实例的基准带宽为100MByte/秒。 - dms.instance.kafka.cluster.c3.small.2：Kafka实例的基准带宽为300MByte/秒。 - dms.instance.kafka.cluster.c3.middle.2：Kafka实例的基准带宽为600MByte/秒。 - dms.instance.kafka.cluster.c3.high.2：Kafka实例的基准带宽为1200MByte/秒。 | | charging_mode | Integer | 计费模式。 1表示按需计费 0表示包周期计费 | | vpc_id | String | VPC ID。 | | vpc_name | String | VPC的名称。 | | created_at | String | 完成创建时间。 格式为时间戳，指从格林威治时间 1970年01月01日00时00分00秒起至指定时间的偏差总毫秒数。 | | product_id | String | 产品标识。 | | security_group_id | String | 安全组ID。 | | security_group_name | String | 租户安全组名称。 | | subnet_id | String | 子网ID。 | | subnet_name | String | 子网名称。 | | subnet_cidr | String | 子网网段。 | | available_zones | Array of strings | 实例节点所在的可用区，返回"可用区ID"。 | | user_id | String | 用户ID。 | | user_name | String | 用户名。 | | maintain_begin | String | 维护时间窗开始时间，格式为HH:mm:ss。 | | maintain_end | String | 维护时间窗结束时间，格式为HH:mm:ss。 | | enable_log_collection | Boolean | 是否开启消息收集功能。 | | new_auth_cert | Boolean | 是否使用新证书。 | | storage_space | Integer | 消息存储空间，单位：GB。 | | total_storage_space | Integer | 总共消息存储空间，单位：GB。 | | used_storage_space | Integer | 已使用的消息存储空间，单位：GB。 | | enable_publicip | Boolean | 实例是否开启公网访问功能。 - true：开启 - false：未开启 | | publicip_address | String | 公网连接地址。 | | ssl_enable | Boolean | 是否开启安全认证。 - true：开启 - false：未开启 | | cross_vpc_info | String | 跨VPC访问信息。 | | storage_resource_id | String | 存储资源ID。 | | storage_spec_code | String | IO规格。 | | service_type | String | 服务类型。 | | storage_type | String | 存储类型。 | | extend_times | Integer | 实例扩容磁盘次数，如果超过20次则无法扩容磁盘。 | | ipv6_enable | Boolean | 是否开启ipv6。 | | support_features | String | Kafka实例支持的特性功能。 | | disk_encrypted | Boolean | 是否开启磁盘加密。 | | ces_version | String | 云监控版本。 | | node_num | Integer | 节点数量。 | | new_spec_billing_enable | Boolean | 是否启用新规格计费。 | | enable_acl | Boolean | 是否开启acl。 | | broker_num | Integer | 节点数。 | | dr_enable | Boolean | 节点数。 | | namesrv_address | String | 元数据地址。 | | broker_address | String | 业务数据地址。 | | public_namesrv_address | String | 公网元数据地址。 | | public_broker_address | String | 公网业务数据地址。 | | listeners | Object | 监听信息。 | | partition_num | String | 最大分区数。不同规格的ROMA Connect实例的最大分区数不相同。 | | connect_address | String | 实例连接IP地址。 | | port | Integer | 实例连接端口。 | | order_id | String | 订单ID，只有在包周期计费时才会有order_id值，其他计费方式order_id值为空。 | | management_connect_address | String | Kafka实例的KafkaManager连接地址。 | | enterprise_project_id | String | 企业项目ID。 | | is_logical_volume | Boolean | 实例扩容时用于区分老实例与新实例。 - true：新创建的实例，允许磁盘动态扩容不需要重启。 - false：老实例 | | enable_auto_topic | Boolean | 是否打开kafka自动创建topic功能。 - true：开启 - false：关闭 | | public_connect_address | String | 实例公网连接IP地址。当实例开启了公网访问，实例才包含该参数。 | | retention_policy | String | 消息老化策略。 | | kafka_public_status | String | Kafka公网开启状态。 | | public_bandwidth | Integer | 公网带宽。 | | kafka_manager_user | String | 登录Kafka Manager的用户名。 | | ipv6_connect_addresses | Array of strings | IPv6的连接地址。 | | connector_enable | Boolean | 是否开启转储。 | | connector_id | String | 转储任务ID。 | | mqs_connector_enable | Boolean | 是否开启MQS connector。 | | mqs_connector_address | String | MQS connector地址。 | | plugin_enable | Boolean | 是否开启插件功能。 | | rest_enable | Boolean | 是否开启Kafka rest功能。 | | rest_connect_address | String | Kafka rest地址。 | | message_query_inst_enable | Boolean | 是否开启消息查询功能。 | | vpc_client_plain | Boolean | 是否开启VPC明文访问。 | | trace_enable | Boolean | 是否开启消息轨迹功能。 | | pod_connect_address | String | 租户侧连接地址。 | | kafka_private_connect_address | String | Kafka实例私有连接地址。 | | kafka_security_protocol | String | Kafka 安全协议。 | | sasl_enabled_mechanisms | Array of strings | SASL认证机制。 | | public_access_enabled | String | 是否开启公网访问。用于区分何时开启的公网访问。 | | public_boundwidth | Integer | 公网访问带宽。 | | access_user | String | 认证用户名。 | | agent_enable | Boolean | 是否开启代理。 | #### 请求示例 ``` GET https://{endpoint}/v2/{project_id}/mqs/instances/{instance_id} ``` #### 响应示例 **状态码：200** OK - ``` { "name" : "romamqs_640bb069-151e-4d5e-bd1b-xxxxxxxxxxxx", "engine" : "kafka", "port" : 9093, "status" : "RUNNING", "description" : "roma-mqs", "type" : "cluster", "specification" : "100MB", "engine_version" : "1.1.0", "connect_address" : "192.168.0.57,192.168.0.227,192.168.0.234", "instance_id" : "640bb069-151e-4d5e-bd1b-xxxxxxxxxxxx", "resource_spec_code" : "dms.instance.kafka.cluster.c3.mini", "charging_mode" : 1, "vpc_id" : "5810f4bb-b202-45cd-a5d1-xxxxxxxxxxxx", "vpc_name" : "vpc-4aeb", "created_at" : "1601016527494", "product_id" : "00300-30308-0--0", "security_group_id" : "20d120f2-70ba-4c8d-a6a4-xxxxxxxxxxxx", "security_group_name" : "sg-5ab2", "subnet_id" : "08c8e51c-7013-43ee-bb0a-xxxxxxxxxxxx", "subnet_name" : "subnet-4afa", "subnet_cidr" : "192.168.0.0/24", "available_zones" : [ "9f1c5806706d4c1fb0eb72f0a9b18c77" ], "user_id" : "4d1a542e7bcf400cb9c8efada01406d8", "user_name" : "paas_test", "access_user" : "mqs-gen-user-1601016526411", "maintain_begin" : "22:00:00", "maintain_end" : "02:00:00", "enable_log_collection" : false, "storage_space" : 490, "total_storage_space" : 600, "used_storage_space" : 25, "partition_num" : "300", "enable_publicip" : true, "publicip_address" : "10.10.10.170", "ssl_enable" : true, "cross_vpc_info" : "{\"192.168.0.227\":{\"advertised_ip\":\"192.168.0.227\",\"port\":9011,\"port_id\":\"6ba24c0a-c3ba-4fb8-9adb-84b7a346a623\"},\"192.168.0.57\":{\"advertised_ip\":\"192.168.0.57\",\"port\":9011,\"port_id\":\"4d34a44d-d968-4dcb-89a9-e38e62626df6\"},\"192.168.0.234\":{\"advertised_ip\":\"192.168.0.234\",\"port\":9011,\"port_id\":\"9eac2e81-323c-4d2d-acce-7f84f2d3bd9b\"}}", "storage_resource_id" : "234705d3-8f33-451a-92aa-xxxxxxxxxxxx", "storage_spec_code" : "dms.physical.storage.normal", "service_type" : "advanced", "storage_type" : "hec", "is_logical_volume" : true, "extend_times" : 0, "retention_policy" : "produce_reject", "ipv6_enable" : false, "ipv6_connect_addresses" : [ ], "connector_enable" : false, "mqs_connector_enable" : true, "mqs_connector_address" : "192.168.0.10:9776;192.168.0.17:9776", "connector_id" : "", "rest_enable" : true, "rest_connect_address" : "https://10.10.10.170:9292", "kafka_public_status" : "false", "public_bandwidth" : 0, "public_boundwidth" : 0, "message_query_inst_enable" : true, "vpc_client_plain" : false, "support_features" : "kafka.crossvpc.domain.enable,feature.physerver.kafka.topic.accesspolicy,rabbitmq.plugin.management,roma_app_enable,auto_topic_switch,feature.physerver.kafka.user.manager,route,kafka.new.pod.port,feature.physerver.kafka.topic.modify,message_trace_enable,features.pod.token.access,roma.user.manage.no.support,feature.physerver.kafka.pulbic.dynamic,features.log.collection", "trace_enable" : false, "agent_enable" : false, "sasl_enabled_mechanisms" : [ "SCRAM-SHA-512", "PLAIN" ], "kafka_security_protocol" : "SASL_PLAINTEXT", "listeners" : [ { "name" : "mqs-kafka-1", "port" : 9096, "backend" : { "ip" : [ "192.168.0.227" ], "port" : 9096, "health_check" : { "protocol" : "TCP_CHECK", "port" : 9093, "param" : null } } }, { "name" : "mqs-kafka-2", "port" : 9097, "backend" : { "ip" : [ "192.168.0.234" ], "port" : 9097, "health_check" : { "protocol" : "TCP_CHECK", "port" : 9093, "param" : null } } }, { "name" : "mqs-connector-0", "port" : 20911, "backend" : { "ip" : [ "192.168.0.10" ], "port" : 20911, "health_check" : { "protocol" : "TCP_CHECK", "port" : 20911, "param" : null } } }, { "name" : "mqs-connector-1", "port" : 20912, "backend" : { "ip" : [ "192.168.0.17" ], "port" : 20912, "health_check" : { "protocol" : "TCP_CHECK", "port" : 20912, "param" : null } } }, { "name" : "mqs-kafka-0", "port" : 9095, "backend" : { "ip" : [ "192.168.0.57" ], "port" : 9095, "health_check" : { "protocol" : "TCP_CHECK", "port" : 9093, "param" : null } } }, { "name" : "mqs-namesrv", "port" : 9776, "backend" : { "ip" : [ "192.168.0.10", "192.168.0.17" ], "port" : 9776, "health_check" : { "protocol" : "TCP_CHECK", "port" : 9776, "param" : null } } }, { "name" : "mqs-rest", "port" : 9292, "backend" : { "ip" : [ "192.168.0.38", "192.168.0.230" ], "port" : 9292, "health_check" : { "protocol" : "TCP_CHECK", "port" : 9292, "param" : null } } } ], "pod_connect_address" : "10.10.10.122:9080,10.10.10.96:9080,10.10.10.66:9080", "disk_encrypted" : false, "kafka_private_connect_address" : "192.168.0.227:9093,192.168.0.234:9093,192.168.0.57:9093", "enable_auto_topic" : false, "ces_version" : "linux,v1,v2", "plugin_enable" : false, "public_access_enabled" : "false", "node_num" : 3 } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-roma/ErrorCode.html)。