文档首页/ 应用与数据集成平台 ROMA Connect/ API参考/ 消息集成API/ MQS实例管理/ 查询MQS实例列表
更新时间：2024-07-03 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询MQS实例列表

功能介绍

查询MQS实例列表。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/mqs/instances

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见API参考的“附录 > 获取项目ID”章节。
表2 Query参数

参数

是否必选

参数类型

描述

include_internal

是

String

是否包含内部的实例。include_internal参数必须为true（测试版本）。

engine

否

String

引擎类型（Kafka，RocketMQ），查询RocketMQ实例填写：reliability。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

无

请求示例

GET https://{endpoint}/v2/{project_id}/mqs/instances?include_internal=true

响应示例

状态码： 200

OK

  • {
  "instances" : [ {
    "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",
    "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" : false,
    "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,
    "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
  }, {
    "name" : "romamqs_54fc780d-bf6f-4402-8149-xxxxxxxxxxxx",
    "engine" : "kafka",
    "port" : 9093,
    "status" : "RUNNING",
    "description" : "roma-mqs",
    "type" : "cluster",
    "specification" : "100MB",
    "engine_version" : "1.1.0",
    "connect_address" : "192.168.0.25,192.168.0.92,192.168.0.220",
    "instance_id" : "54fc780d-bf6f-4402-8149-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" : "1600075938106",
    "product_id" : "00300-30308-0--0",
    "security_group_id" : "a9b9667f-8a48-4317-b637-xxxxxxxxxxxx",
    "security_group_name" : "default",
    "subnet_id" : "08c8e51c-7013-43ee-bb0a-xxxxxxxxxxxx",
    "available_zones" : [ "9f1c5806706d4c1fb0eb72f0a9b18c77" ],
    "user_id" : "4d1a542e7bcf400cb9c8efada01406d8",
    "user_name" : "paas_test",
    "access_user" : "mqs-gen-user-1600075937011",
    "maintain_begin" : "22:00:00",
    "maintain_end" : "02:00:00",
    "enable_log_collection" : false,
    "storage_space" : 492,
    "total_storage_space" : 600,
    "used_storage_space" : 25,
    "partition_num" : "300",
    "enable_publicip" : false,
    "ssl_enable" : true,
    "cross_vpc_info" : "{\"192.168.0.25\":{\"advertised_ip\":\"192.168.0.25\",\"port\":9011,\"port_id\":\"bcf9ba5e-26f4-4d09-b566-014eac1c804b\"},\"192.168.0.92\":{\"advertised_ip\":\"192.168.0.92\",\"port\":9011,\"port_id\":\"43bbffdd-07bf-450f-b1cd-c5e553c77c0f\"},\"192.168.0.220\":{\"advertised_ip\":\"192.168.0.220\",\"port\":9011,\"port_id\":\"dc26f9c0-2d2b-4522-9f22-b5b3d726121e\"}}",
    "storage_resource_id" : "0b391dcb-ccc8-4f9d-9440-xxxxxxxxxxxx",
    "storage_spec_code" : "dms.physical.storage.high",
    "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.66:9776;192.168.0.65:9776",
    "connector_id" : "",
    "rest_enable" : true,
    "rest_connect_address" : "https://10.10.10.57: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,route,kafka.new.pod.port,feature.physerver.kafka.topic.modify,feature.physerver.kafka.topic.accesspolicy,message_trace_enable,features.pod.token.access,rabbitmq.plugin.management,roma_app_enable,features.log.collection,auto_topic_switch,feature.physerver.kafka.user.manager",
    "trace_enable" : false,
    "agent_enable" : false,
    "pod_connect_address" : "10.10.10.244:9080,10.10.10.79:9080,10.10.10.64:9080",
    "disk_encrypted" : false,
    "kafka_private_connect_address" : "192.168.0.25:9093,192.168.0.92:9093,192.168.0.220:9093",
    "enable_auto_topic" : false,
    "ces_version" : "linux,v1,v2",
    "plugin_enable" : false,
    "public_access_enabled" : "false",
    "node_num" : 3
  } ],
  "instance_num" : 2
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： MQS实例管理

相关文档