Querying MQS Instance Details
Function
This API is used to query details of an MQS instance.
URI
GET /v2/{project_id}/mqs/instances/{instance_id}
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID. For details about how to obtain a project ID, see "Appendix" > "Obtaining a Project ID" in this document. |
| instance_id | Yes | String | Instance ID. |
Request 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
| Parameter | Type | Description |
|---|---|---|
| name | String | Instance name. |
| engine | String | Message engine. |
| status | String | Instance status. |
| description | String | Description. |
| type | String | Instance type. The value can be cluster. |
| specification | String | |
| engine_version | String | Version. |
| instance_id | String | Instance ID. |
| resource_spec_code | String | |
| charging_mode | Integer | |
| vpc_id | String | |
| vpc_name | String | |
| created_at | String | Time when an instance was created. The time is a Unix timestamp, in millisecond. |
| product_id | String | |
| security_group_id | String | |
| security_group_name | String | |
| subnet_id | String | |
| subnet_name | String | |
| subnet_cidr | String | |
| available_zones | Array of strings | |
| user_id | String | User ID. |
| user_name | String | Username. |
| 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_log_collection | Boolean | |
| new_auth_cert | Boolean | Whether to use the new certificate. |
| storage_space | Integer | |
| total_storage_space | Integer | |
| used_storage_space | Integer | |
| enable_publicip | Boolean | |
| publicip_address | String | |
| ssl_enable | Boolean | Whether security authentication is enabled. |
| cross_vpc_info | String | |
| storage_resource_id | String | |
| storage_spec_code | String | |
| service_type | String | |
| storage_type | String | |
| extend_times | Integer | |
| ipv6_enable | Boolean | |
| support_features | String | List of features supported by the Kafka instance. |
| disk_encrypted | Boolean | |
| ces_version | String | Cloud Eye version. |
| node_num | Integer | Node quantity. |
| new_spec_billing_enable | Boolean | Whether to enable billing based on new specifications. |
| enable_acl | Boolean | Whether to enable ACL. |
| broker_num | Integer | Node count. |
| dr_enable | Boolean | Node count. |
| namesrv_address | String | Metadata address. |
| broker_address | String | Service data address. |
| public_namesrv_address | String | Public network metadata address. |
| public_broker_address | String | Public network service data address. |
| listeners | Object | |
| partition_num | String | Maximum number of partitions. |
| connect_address | String | IP address of an instance. |
| port | Integer | Port of an instance. |
| order_id | String | |
| management_connect_address | String | |
| enterprise_project_id | String | Enterprise project ID. |
| is_logical_volume | Boolean | |
| enable_auto_topic | Boolean | |
| public_connect_address | String | |
| retention_policy | String | Message retention policy. |
| kafka_public_status | String | |
| public_bandwidth | Integer | |
| kafka_manager_user | String | |
| ipv6_connect_addresses | Array of strings | |
| connector_enable | Boolean | |
| connector_id | String | |
| mqs_connector_enable | Boolean | |
| mqs_connector_address | String | |
| plugin_enable | Boolean | |
| rest_enable | Boolean | |
| rest_connect_address | String | |
| message_query_inst_enable | Boolean | Whether message query is enabled. |
| vpc_client_plain | Boolean | |
| trace_enable | Boolean | |
| pod_connect_address | String | Connection address of the tenant side. |
| kafka_private_connect_address | String | Private connection address of the Kafka instance. |
| kafka_security_protocol | String | Kafka security protocol. |
| sasl_enabled_mechanisms | Array of strings | SASL authentication mechanism. |
| public_access_enabled | String | |
| public_boundwidth | Integer | |
| access_user | String | |
| agent_enable | Boolean |
Example Requests
GET https://{endpoint}/v2/{project_id}/mqs/instances/{instance_id} Example Responses
Status code: 200
OK
Status Codes
| Status Code | Description |
|---|---|
| 200 | OK |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.