Querying an Instance
Function
This API is used to query the details about a specified instance.
Debugging
You can use API Explorer to debug this API.
URI
GET /v2/{project_id}/instances/{instance_id}
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID. |
| instance_id | Yes | String | Instance ID. |
Request Parameters
None
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| name | String | Instance name. |
| engine | String | Message engine. |
| engine_version | String | Version of the message engine. |
| specification | String | Instance specifications.
|
| storage_space | Integer | Message storage space in GB. |
| 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. |
| description | String | Instance description |
| instance_id | String | Instance ID. |
| resource_spec_code | String | Resource specification code.
|
| charging_mode | Integer | Billing mode. The value 1 means pay-per-use, and 0 means yearly/monthly. |
| vpc_id | String | VPC ID. |
| vpc_name | String | VPC name. |
| created_at | String | Time when an instance was created. The time is in the format of timestamp, that is, the offset milliseconds from 1970-01-01 00:00:00 UTC to the specified time. |
| user_id | String | User ID. |
| user_name | String | Username. |
| order_id | String | Order ID. This parameter has a value only when the billing mode is 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 to enable public access for the RabbitMQ instance.
|
| publicip_address | String | EIP bound to the RabbitMQ instance. The value of this parameter is null if public access is disabled. |
| publicip_id | String | ID of the EIP bound to the RabbitMQ instance. The value of this parameter is null if public access is disabled. |
| management_connect_address | String | Management address of a RabbitMQ instance. |
| ssl_enable | Boolean | Whether security authentication is enabled.
|
| 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.
|
| extend_times | Integer | Number of disk expansion times. If the value exceeds 20, disk expansion is no longer allowed. |
| 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. |
| available_zones | Array of strings | AZ to which the instance nodes belong. The AZ ID is returned. |
| total_storage_space | Integer | Message storage space in GB. |
| storage_resource_id | String | Storage resource ID. |
| storage_spec_code | String | I/O specifications. |
| ipv6_enable | Boolean | Whether IPv6 is enabled. |
| ipv6_connect_addresses | Array of strings | IPv6 connection address. |
| tags | Array of TagEntity objects | Tag list. |
| Parameter | Type | Description |
|---|---|---|
| key | String | Tag key, which can contain a maximum of 36 Unicode characters. The key cannot be left blank or an empty string. It cannot contain nonprintable ASCII (0–31) characters and the following special characters: =*<>,|/ |
| value | String | Tag value,which can contain a maximum of 43 Unicode characters. The value cannot be left blank but can be an empty string. It cannot contain nonprintable ASCII (0–31) characters and the following special characters: =*<>,|/ |
Example Requests
GET https://{endpoint}/v2/{project_id}/instances/{instance_id} Example Responses
Status code: 200
The specified instance is queried successfully.
{
"name" : "api-explorer",
"engine" : "rabbitmq",
"port" : 5672,
"status" : "RUNNING",
"type" : "single",
"specification" : "2vCPUs 4GB",
"engine_version" : "3.7.17",
"connect_address" : "192.168.0.74",
"connect_dn" : "",
"instance_id" : "de873040-d661-4770-aa96-9329c71d7c8a",
"resource_spec_code" : "dms.instance.rabbitmq.single.c3.2u4g",
"charging_mode" : 1,
"vpc_id" : "40a6501e-85ca-4449-a0db-b8bc7f0cec28",
"vpc_name" : "vpc-a400",
"created_at" : "1590047080687",
"product_id" : "00300-30109-0--0",
"security_group_id" : "bfd68e26-f8ef-4a91-a373-0a8f5c198601",
"security_group_name" : "Sys-default",
"subnet_id" : "a7f9a564-30dd-4059-8124-364ca6554578",
"subnet_name" : "subnet-a429",
"subnet_cidr" : "192.168.0.0/24",
"available_zones" : [ "9f1c5806706d4c1fb0eb72f0a9b18c77" ],
"user_id" : "3df5acbc24a54fadb62a043c9000a307",
"user_name" : "paas_dms_pwx483199_01",
"access_user" : "root",
"maintain_begin" : "22:00:00",
"maintain_end" : "02:00:00",
"enable_log_collection" : false,
"storage_space" : 88,
"total_storage_space" : 100,
"used_storage_space" : 4,
"enable_publicip" : false,
"ssl_enable" : false,
"management_connect_address" : "http://192.168.0.74:15672",
"storage_resource_id" : "52be287d-1d6a-4d30-937e-185b3f176fc4",
"storage_spec_code" : "dms.physical.storage.normal",
"service_type" : "advanced",
"storage_type" : "hec",
"enterprise_project_id" : "0",
"tags" : [ {
"key" : "key1",
"value" : "value1"
}, {
"key" : "key2",
"value" : "value2"
} ],
"is_logical_volume" : true,
"extend_times" : 0,
"ipv6_enable" : false,
"ipv6_connect_addresses" : [ ],
"connector_enable" : false,
"connector_id" : "",
"rest_enable" : false,
"rest_connect_address" : "",
"public_boundwidth" : 0,
"message_query_inst_enable" : true,
"vpc_client_plain" : false,
"support_features" : "kafka.new.pod.port,feature.physerver.kafka.topic.modify,feature.physerver.kafka.topic.accesspolicy,message_trace_enable,features.pod.token.access,feature.physerver.kafka.pulbic.dynamic,roma_app_enable,features.log.collection,auto_topic_switch,feature.physerver.kafka.user.manager",
"trace_enable" : false,
"agent_enable" : false,
"disk_encrypted" : false,
"enable_auto_topic" : false,
"ces_version" : "linux,v1"
} Status Codes
| Status Code | Description |
|---|---|
| 200 | The specified instance is queried successfully. |
Error Codes
See Error Codes.
Last Article: Listing All Instances
Next Article: Deleting an Instance
Did this article solve your problem?
Thank you for your score！Your feedback would help us improve the website.