Querying an Instance
Function
This API is used to query the details about a specified instance.
URI
GET /v2/{project_id}/instances/{instance_id}
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition Project ID. For details, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A |
| instance_id | Yes | String | Definition: Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body. Constraints: N/A Range: N/A Default Value: N/A |
Request Parameters
None
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| access_user | String | Definition: Authentication username. Range: N/A |
| broker_num | Integer | Definition: Number of brokers. Range:
|
| name | String | Definition: Instance name. Range: N/A |
| engine | String | Definition: Engine type. Range: rabbitmq: RabbitMQ engine. |
| engine_version | String | Definition Message engine version. Range
|
| specification | String | Definition: Instance flavor. Range:
|
| storage_space | Integer | Definition: Message storage space, in GB. Range: N/A |
| used_storage_space | Integer | Definition: Used message storage space, in GB. Range: N/A |
| dns_enable | Boolean | Definition: Whether to enable domain name access to an instance. Range:
|
| connect_address | String | Definition: Instance IP address for private access. Range: N/A |
| connect_domain_name | String | Definition: Instance domain name for private access. Range: N/A |
| public_connect_address | String | Definition: Instance IP address for public access. Range: N/A |
| public_connect_domain_name | String | Definition: Instance domain name for public access. Range: N/A |
| port | Integer | Definition: Instance port. Range: N/A |
| status | String | Definition Instance status. Range For details, see Instance Status. |
| description | String | Definition: Instance description. Range: N/A |
| instance_id | String | Definition: Instance ID. Range: N/A |
| resource_spec_code | String | Definition Resource specification ID. Range
|
| charging_mode | Integer | Definition: Billing mode. Range:
|
| vpc_id | String | Definition: VPC ID. Range: N/A |
| vpc_name | String | Definition: VPC name. Range: N/A |
| created_at | String | Definition: Time when the creation is complete. 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. Range: N/A |
| user_id | String | Definition: User ID. Range: N/A |
| user_name | String | Definition: Username. Range: N/A |
| order_id | String | Definition: Indicates an order ID. This parameter has a value only when the billing mode is yearly/monthly mode. Range: N/A |
| maintain_begin | String | Definition: Time at which the maintenance window starts. The format is HH:mm:ss. Range: N/A |
| maintain_end | String | Definition: Time at which the maintenance window ends. The format is HH:mm:ss. Range: N/A |
| enable_publicip | Boolean | Definition: Indicates whether to enable public access for a RabbitMQ instance. Range:
|
| publicip_address | String | Definition: Indicates the EIP bound to a RabbitMQ instance. The value of this parameter is null if public access is disabled. Range:
|
| publicip_id | String | Definition: Indicates the ID of the EIP bound to a RabbitMQ instance. The value of this parameter is null if public access is disabled. Range: N/A |
| management_connect_address | String | Definition: Management address of a RabbitMQ instance. Range: N/A |
| management_connect_domain_name | String | Definition: Management domain name of a RabbitMQ instance. Range: N/A |
| public_management_connect_address | String | Definition: Public management address of a RabbitMQ instance. Range: N/A |
| public_management_connect_domain_name | String | Definition: Public management domain name of a RabbitMQ instance. Range: N/A |
| ssl_enable | Boolean | Definition: Whether security authentication is enabled. Range:
|
| enterprise_project_id | String | Definition: Enterprise project ID. Range: N/A |
| is_logical_volume | Boolean | Definition: Distinguishes old instances from new instances during instance capacity expansion. Range:
|
| extend_times | Integer | Definition Times of scaling up the instance disk. Range N/A |
| type | String | Definition: Instance type. Range:
|
| product_id | String | Definition: Product ID. Range: N/A |
| security_group_id | String | Definition: Security group ID. Range: N/A |
| security_group_name | String | Definition: Name of the tenant security group. Range: N/A |
| subnet_id | String | Definition: Subnet ID. Range: N/A |
| available_zones | Array of strings | Definition: ID of the AZ where an instance node is located. |
| available_zone_names | Array of strings | Definition: Name of the AZ where an instance node is located. |
| total_storage_space | Integer | Definition: Total message storage space, in GB. Range: N/A |
| storage_resource_id | String | Definition: Storage resource ID. Range: N/A |
| storage_spec_code | String | Definition: I/O specification. Range: N/A |
| ipv6_enable | Boolean | Definition: Whether IPv6 is enabled. Range:
|
| ipv6_connect_addresses | Array of strings | Definition: IPv6 connection address. |
| tags | Array of TagEntity objects | Definition: Tag list. |
| service_type | String | Definition Service type. Range advanced |
| storage_type | String | Definition Storage type. Range hec |
Example Requests
Querying details of a specified instance
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.8.35",
"connect_address" : "192.168.0.74",
"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",
"available_zones" : [ "9f1c5806706d4c1fb0eb72f0a9b18c77" ],
"available_zone_names" : [ "AZ1" ],
"user_id" : "3df5acbc24a54fadb62a043c9000a307",
"user_name" : "paas_dms_01",
"maintain_begin" : "22:00:00",
"maintain_end" : "02:00:00",
"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",
"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" : [ ],
"broker_num" : 1,
"access_user" : "root_01"
} Status Codes
| Status Code | Description |
|---|---|
| 200 | The specified instance is queried successfully. |
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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot