Querying MQS Instances

Function

This API is used to query a list of MQS instances.

URI

GET /v2/{project_id}/mqs/instances

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Tenant's project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
include_internal	Yes	String	Whether internal instances are included. The value must be true.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
instances	Array of ShowInstanceResp objects	Instance list.
instance_num	Integer	Number of instances.

**Table 5** ShowInstanceResp
Parameter	Type	Description
name	String	Instance name.
description	String	Description.
engine	String	Message engine.
engine_version	String	Version.
specification	String	Instance specifications.
storage_space	Integer	Message storage space, in GB.
partition_num	String	Maximum number of partitions. The value varies depending on the ROMA Connect instance specifications
used_storage_space	Integer	Used message storage space, in GB.
connect_address	String	IP address of an instance.
port	Integer	Port of an instance.
status	String	Instance status. CREATING: The instance is being created. RUNNING: The instance is running properly. Only instances in the Running state can provide services.
instance_id	String	Instance ID.
resource_spec_code	String	Resource specification code. - dms.instance.kafka.cluster.c3.mini: Kafka instance, 100 MB/s reference bandwidth - dms.instance.kafka.cluster.c3.small.2: Kafka instance, 300 MB/s reference bandwidth - dms.instance.kafka.cluster.c3.middle.2: Kafka instance, 600 MB/s reference bandwidth - dms.instance.kafka.cluster.c3.high.2: Kafka instance, 1200 MB/s reference bandwidth
charging_mode	Integer	Billing mode. 1: Pay per use 0: Yearly/Monthly
vpc_id	String	VPC ID.
vpc_name	String	VPC name.
created_at	String	Time when an instance was created. The time is a Unix timestamp, in millisecond.
user_id	String	User ID.
user_name	String	Username.
order_id	String	Order ID. This parameter has a value only when charging_mode is 0 (yearly/monthly).
maintain_begin	String	Time at which the maintenance time window starts. The format is HH:mm:ss.
maintain_end	String	Time at which the maintenance time window ends. The format is HH:mm:ss.
enable_publicip	Boolean	Whether public access is enabled for an instance. - true: Public access is enabled. - false: Public access is disabled.
management_connect_address	String	Connection address of the Kafka Manager of a Kafka instance.
ssl_enable	Boolean	Whether security authentication is enabled. true: Security authentication is enabled. false: Security authentication is disabled.
enterprise_project_id	String	Enterprise project ID.
is_logical_volume	Boolean	Whether the instance is a new instance. This parameter is used to distinguish old instances from new instances during instance capacity expansion. - true: New instance, which allows dynamic disk capacity expansion without restarting the instance. - false: Old instance.
extend_times	Integer	Number of disk expansion times. If the value exceeds 20, no more disk cannot be added.
enable_auto_topic	Boolean	Whether automatic topic creation is enabled. - true: Automatic topic creation is enabled. - false: Automatic topic creation is disabled.
type	String	Instance type. The value can be cluster.
product_id	String	Product ID.
security_group_id	String	Security group ID.
security_group_name	String	Security group name.
subnet_id	String	Subnet ID.
subnet_name	String	Subnet name.
subnet_cidr	String	Subnet segment.
available_zones	Array of strings	AZ to which the instance node belongs. The AZ ID is returned.
total_storage_space	Integer	Message storage space, in GB.
public_connect_address	String	IP address of the instance for public access. This parameter is available only when public access is enabled for the instance.
storage_resource_id	String	Storage resource ID.
storage_spec_code	String	I/O specifications.
service_type	String	Service type.
storage_type	String	Storage class.
retention_policy	String	Message retention policy.
kafka_public_status	String	Whether public access is enabled for Kafka.
public_bandwidth	Integer	Internet bandwidth.
kafka_manager_user	String	Username for logging in to the Kafka Manager.
enable_log_collection	Boolean	Whether log collection is enabled.
cross_vpc_info	String	Cross-VPC access information.
ipv6_enable	Boolean	Whether IPv6 is enabled.
ipv6_connect_addresses	Array of strings	IPv6 connection address.
connector_enable	Boolean	Whether dumping is enabled.
connector_id	String	Dump task ID.
mqs_connector_enable	Boolean	Whether to enable the MQS dump function.
mqs_connector_address	String	MQS dump address.
plugin_enable	Boolean	Whether to enable the plug-in function.
rest_enable	Boolean	Whether Kafka REST is enabled.
rest_connect_address	String	Connection address of the Kafka REST.
message_query_inst_enable	Boolean	Whether message query is enabled.
vpc_client_plain	Boolean	Whether intra-VPC plaintext access is enabled.
support_features	String	List of features supported by the Kafka instance.
trace_enable	Boolean	Whether message tracing is enabled.
pod_connect_address	String	Connection address of the tenant side.
disk_encrypted	Boolean	Whether disk encryption is enabled.
kafka_private_connect_address	String	Private connection address of the Kafka instance.
ces_version	String	Cloud Eye version.
node_num	Integer	Node quantity.
publicip_address	String	Public network connection address.
listeners	Object	Listener information.
public_access_enabled	String	Whether public network access is enabled. This API differs from the API indicating the time when public network access is enabled.
public_boundwidth	Integer	Public network access bandwidth.
access_user	String	Access username
agent_enable	Boolean	Whether to enable the proxy.

Example Requests

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

Example Responses

Status code: 200

{
  "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
}