Querying an Instance
Function
This API is used to query the details about an instance.
Call Method
For details, see How to Call an API.
URI
GET /v2/{engine}/{project_id}/instances/{instance_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
engine |
Yes |
String |
Engine. |
project_id |
Yes |
String |
Project ID. For details, see Obtaining a Project ID. |
instance_id |
Yes |
String |
Indicates the instance ID. |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
name |
String |
Indicates the instance name. |
engine |
String |
Engine. |
status |
String |
Status. |
description |
String |
Message description. |
type |
String |
Indicates the instance type. Value: cluster. |
specification |
String |
Indicates the instance specification. |
engine_version |
String |
Version. |
instance_id |
String |
Indicates the instance ID. |
charging_mode |
Integer |
Indicates the billing mode. 1: pay-per-use mode; 0: yearly/monthly billing. |
vpc_id |
String |
VPC ID. |
vpc_name |
String |
VPC name. |
created_at |
String |
Indicates the time when an instance is 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. |
product_id |
String |
Indicates the product ID. |
security_group_id |
String |
Indicates the security group ID. |
security_group_name |
String |
Indicates the security group name. |
subnet_id |
String |
Indicates the subnet ID. |
subnet_name |
String |
Indicates the subnet name. |
subnet_cidr |
String |
Subnet route. This field is displayed only for RocketMQ 5.x. |
available_zones |
Array of strings |
AZ ID list. |
available_zone_names |
Array of strings |
AZ name list. |
user_id |
String |
User ID. |
user_name |
String |
Indicates the username. |
maintain_begin |
String |
Time at which the maintenance time window starts. Format: HH:mm:ss. |
maintain_end |
String |
Time at which the maintenance time window ends. Format: HH:mm:ss. |
enable_log_collection |
Boolean |
Indicates whether log collection is enabled. |
storage_space |
Integer |
Storage space, in GB. |
used_storage_space |
Integer |
Used message storage space. Unit: GB. |
enable_publicip |
Boolean |
Whether to enable public access. |
publicip_id |
String |
ID of the elastic IP address (EIP) bound to an instance. Use commas (,) to separate multiple EIP IDs. This parameter is mandatory if public access is enabled (that is, enable_publicip is set to true). |
publicip_address |
String |
Public IP address. |
ssl_enable |
Boolean |
Whether SSL is enabled. |
cross_vpc_info |
String |
Indicates cross-VPC access information. |
storage_resource_id |
String |
Indicates the storage resource ID. |
storage_spec_code |
String |
Storage specification code. |
service_type |
String |
Indicates the service type. |
storage_type |
String |
Indicates the storage type. |
extend_times |
Long |
Extension time. |
ipv6_enable |
Boolean |
Whether IPv6 is enabled. |
support_features |
String |
Features supported by the instance. |
disk_encrypted |
Boolean |
Indicates whether disk encryption is enabled. |
ces_version |
String |
Indicates the Cloud Eye version. |
node_num |
Integer |
Number of nodes. |
new_spec_billing_enable |
Boolean |
Whether billing based on new specifications is enabled. |
enable_acl |
Boolean |
Whether access control is enabled. |
broker_num |
Integer |
Number of nodes (displayed only for RocketMQ 4.8.0). |
dns_enable |
Boolean |
Whether to enable domain name access to an instance. |
namesrv_address |
String |
Metadata address. |
namesrv_domain_name |
String |
Metadata domain name. |
broker_address |
String |
Service data address. |
public_namesrv_address |
String |
Public network metadata address. |
public_namesrv_domain_name |
String |
Public metadata domain name. |
public_broker_address |
String |
Public network service data address. |
grpc_address |
String |
gRPC connection address (displayed only for RocketMQ 5.x). |
grpc_domain_name |
String |
gRPC connection domain name (displayed only for RocketMQ 5.x). |
public_grpc_address |
String |
Public gRPC connection address (displayed only for RocketMQ 5.x). |
public_grpc_domain_name |
String |
Public gRPC domain name (displayed only for RocketMQ 5.x). |
enterprise_project_id |
String |
Indicates the enterprise project ID. |
tags |
Array of TagEntity objects |
Indicates the list of tags. |
total_storage_space |
Integer |
Total storage space. |
resource_spec_code |
String |
Resource specification. |
Example Requests
GET https://{endpoint}/v2/{engine}/{project_id}/instances/{instance_id}
Example Response
Status code: 200
Metrics queried successfully.
{ "name" : "reliability-test", "engine" : "reliability", "status" : "RUNNING", "description" : "", "type" : "single.basic", "specification" : "rocketmq.b1.large.1, 500 tps", "engine_version" : "5.x", "instance_id" : "68fdc9a8-805e-439d-8dd9-25adc1c58bf6", "resource_spec_code" : "", "charging_mode" : 1, "vpc_id" : "3db8490c-4d6d-4d8f-8d3f-047b0de4c5cf", "vpc_name" : "vpc-1101840", "created_at" : "1636699753874", "product_id" : "rocketmq.b1.large.1", "security_group_id" : "23c5977f-ff33-4b95-a73e-08d8a0bc4e6c", "security_group_name" : "security_group_test", "subnet_id" : "0a0f1fcb-f019-458d-b9e5-301867394d50", "subnet_name" : "subnet-test", "subnet_cidr" : "192.168.64.0/18", "available_zones" : [ "9f1c5806706d4c1fb0eb72f0a9b18c77" ], "available_zone_names" : [ "AZ3" ], "user_id" : "0b01fbb53600d4671fa8c00673c71260", "user_name" : "user_test", "maintain_begin" : "02:00:00", "maintain_end" : "06:00:00", "enable_log_collection" : false, "storage_space" : 558, "total_storage_space" : 600, "used_storage_space" : 28, "enable_publicip" : true, "publicip_id" : "83924171-7014-48f0-a6b2-c714e7a090dd", "publicip_address" : "***", "ssl_enable" : false, "cross_vpc_info" : "{\"192.168.93.114\":{\"advertised_ip\":\"192.168.93.114\",\"broker_port\":\"10100\",\"port_id\":\"b3de3981-1f73-4e6f-b35a-78833b783364\",\"namesrv_port\":\"8300\"}}", "storage_resource_id" : "164bdaef-2e67-4fd5-be8b-a18f91d455a2", "storage_spec_code" : "dms.physical.storage.ultra.v2", "service_type" : "advanced", "storage_type" : "hec", "enterprise_project_id" : "0", "extend_times" : 0, "ipv6_enable" : false, "support_features" : "kafka.crossvpc.domain.enable,auto.create.topics.enable,rabbitmq.plugin.management,support.permissive.mode,auto_topic_switch,feature.physerver.kafka.user.manager,kafka.ssl.2way.modify.enable,kafka.new.pod.port,message_trace_enable,features.pod.token.access,log.enable,features.log.collection,max.connections,rabbitmq.manage.support,replica_port_standalone,feature.physerver.kafka.topic.accesspolicy,enable.kafka.quota.monitor,rocketmq.acl,roma_app_enable,support.kafka.producer.ip,enable.new.authinfo,enable.kafka.quota,rabbitmq_run_log_enable,max.ssl.connections,route,message_trace_v2_enable,kafka.config.dynamic.modify.enable,feature.physerver.kafka.topic.modify,enable.topic.quota,kafka.ssl.cert.modify.enable,roma.user.manage.no.support,auto.create.groups.enable,feature.physerver.kafka.pulbic.dynamic,kafka.config.static.modify.enable", "disk_encrypted" : false, "ces_version" : "linux,v1,v2,v3,v4", "new_spec_billing_enable" : true, "enable_acl" : false, "namesrv_address" : "192.168.93.114:8100", "broker_address" : "192.168.64.0/18:10100", "public_namesrv_address" : "100.85.116.211:8200", "public_broker_address" : "100.85.116.211:10101", "grpc_address" : "192.168.93.114:8080", "public_grpc_address" : "100.85.116.211:8081" }
Status Code
Status Code |
Description |
---|---|
200 |
Successful |
Error Code
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