Querying an Instance
Function
This API is used to query the details about a specified instance.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/instances/{instance_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain it, see Obtaining a 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. |
description |
String |
Instance description |
specification |
String |
Instance specifications. |
storage_space |
Integer |
Message storage space in GB. |
partition_num |
String |
Number of partitions in a Kafka instance. |
used_storage_space |
Integer |
Used message storage space in GB. |
dns_enable |
Boolean |
Indicates whether domain name access is enabled for an instance.
|
connect_address |
String |
IP address of an instance. |
port |
Integer |
Port of an instance. |
status |
String |
Instance status. For details, see Instance Status. |
instance_id |
String |
Instance ID. |
resource_spec_code |
String |
Resource specifications.
|
charging_mode |
Integer |
Billing mode. 1: pay-per-use. |
vpc_id |
String |
VPC ID. |
vpc_name |
String |
VPC name. |
created_at |
String |
Time when the 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. |
subnet_name |
String |
Subnet name. |
subnet_cidr |
String |
Subnet CIDR block. |
user_id |
String |
User ID. |
user_name |
String |
Username. |
access_user |
String |
Username for accessing the instance. |
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 public access is enabled for the instance.
|
management_connect_address |
String |
Connection address of Kafka Manager of the Kafka instance. |
ssl_enable |
Boolean |
Whether security authentication is enabled.
|
broker_ssl_enable |
Boolean |
Indicates whether to enable encrypted replica transmission among brokers.
|
kafka_security_protocol |
String |
Security protocol used by Kafka. If port-protocols is returned in the instance details, kafka_security_protocol works as the security protocol for private and public network access, and cross-VPC access. Otherwise, kafka_security_protocol works as the security protocol only for cross-VPC access. For the security protocol for private and public network access, see port_protocols.
|
sasl_enabled_mechanisms |
Array of strings |
Authentication mechanism used after SASL is enabled.
|
ssl_two_way_enable |
Boolean |
Indicates whether to enable two-way authentication. |
cert_replaced |
Boolean |
Whether the certificate can be replaced. |
public_management_connect_address |
String |
Address for accessing Kafka Manager over public networks. |
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. |
enable_auto_topic |
Boolean |
Indicates whether to enable automatic topic creation.
|
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 brokers belong. The AZ ID is returned. |
available_zone_names |
Array of strings |
Name of the AZ to which the instance node belongs. The AZ name is returned. |
total_storage_space |
Integer |
Message storage space in GB. |
public_connect_address |
String |
Instance public access address. This parameter is available only when public access is enabled for the instance. |
public_connect_domain_name |
String |
Public network access domain name of the instance. 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 |
Public network access bandwidth. |
enable_log_collection |
Boolean |
Whether log collection is enabled. |
new_auth_cert |
Boolean |
Indicates whether to enable a new certificate. |
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. Dumping is not supported for the new specification type. |
connector_node_num |
Integer |
Number of connectors. |
connector_id |
String |
Dumping task ID. |
rest_enable |
Boolean |
Whether Kafka REST is enabled. |
rest_connect_address |
String |
Kafka REST connection address. |
public_boundwidth |
Integer |
Public network access bandwidth. To be deleted. |
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. |
agent_enable |
Boolean |
Indicates whether the proxy is enabled. |
pod_connect_address |
String |
Connection address on the tenant side. |
disk_encrypted |
Boolean |
Whether disk encryption is enabled. |
disk_encrypted_key |
String |
Disk encryption key. If disk encryption is not enabled, this parameter is left blank. |
kafka_private_connect_address |
String |
Private connection address of a Kafka instance. |
kafka_private_connect_domain_name |
String |
Private connection domain name of a Kafka instance. |
ces_version |
String |
Cloud Eye version. |
public_access_enabled |
String |
Time when public access was enabled for an instance. Value range:
|
node_num |
Integer |
Node quantity. |
port_protocols |
PortProtocolsEntity object |
Connection modes and addresses supported by an instance. |
enable_acl |
Boolean |
Indicates whether access control is enabled. |
new_spec_billing_enable |
Boolean |
Whether billing based on new specifications is enabled. |
broker_num |
Integer |
Broker quantity. |
tags |
Array of TagEntity objects |
Tag list. |
dr_enable |
Boolean |
Indicates whether DR is enabled. |
Parameter |
Type |
Description |
---|---|---|
private_plain_enable |
Boolean |
Whether the instance supports private plaintext access.
|
private_plain_address |
String |
Connection addresses of Kafka private plaintext access. |
private_plain_domain_name |
String |
Private plaintext connection domain name. |
private_sasl_ssl_enable |
Boolean |
Whether the instance supports private SASL_SSL access.
|
private_sasl_ssl_address |
String |
Connection addresses of the Kafka private SASL_SSL access mode. |
private_sasl_ssl_domain_name |
String |
Private SASL_SSL connection domain name. |
private_sasl_plaintext_enable |
Boolean |
Whether the instance supports private SASL_PLAINTEXT access.
|
private_sasl_plaintext_address |
String |
Connection addresses of the Kafka private SASL_PLAINTEXT access mode. |
private_sasl_plaintext_domain_name |
String |
Private SASL_PLAINTEXT connection domain name. |
public_plain_enable |
Boolean |
Whether the instance supports public plaintext access.
|
public_plain_address |
String |
Connection addresses of Kafka public plaintext access. |
public_plain_domain_name |
String |
Public plaintext connection domain name. |
public_sasl_ssl_enable |
Boolean |
Whether the instance supports public SASL_SSL access.
|
public_sasl_ssl_address |
String |
Connection addresses of the Kafka public SASL_SSL access mode. |
public_sasl_ssl_domain_name |
String |
Public SASL_SSL connection domain name. |
public_sasl_plaintext_enable |
Boolean |
Whether the instance supports public SASL_PLAINTEXT access.
|
public_sasl_plaintext_address |
String |
Connection addresses of the Kafka public SASL_PLAINTEXT access mode. |
public_sasl_plaintext_domain_name |
String |
Public SASL_PLAINTEXT connection domain name. |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Tag key.
|
value |
String |
Tag value.
|
Example Requests
Querying an instance
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}
Example Responses
Status code: 200
Specified instance queried.
{ "name" : "kafka-2085975099", "engine" : "kafka", "port" : 9092, "status" : "RUNNING", "type" : "cluster", "specification" : "kafka.2u4g.cluster * 3 broker", "engine_version" : 2.7, "connect_address" : "192.168.0.100,192.168.0.61,192.168.0.72", "instance_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "resource_spec_code" : "dms.instance.kafka.cluster.c3.mini", "charging_mode" : 1, "vpc_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "vpc_name" : "dms-test", "created_at" : "1585618587087", "product_id" : "00300-30308-0--0", "security_group_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "security_group_name" : "Sys-default", "subnet_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "available_zones" : [ "38b0f7a602344246bcb0da47b5d548e7" ], "available_zone_names" : [ "AZ1" ], "user_id" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "user_name" : "paas_dms", "maintain_begin" : "02:00:00", "maintain_end" : "06:00:00", "enable_log_collection" : false, "new_auth_cert" : false, "storage_space" : 492, "total_storage_space" : 600, "used_storage_space" : 25, "partition_num" : "300", "enable_publicip" : false, "ssl_enable" : false, "broker_ssl_enable" : false, "cert_replaced" : false, "management_connect_address" : "https://192.168.0.100:9999", "cross_vpc_info" : "{\"192.168.0.61\":{\"advertised_ip\":\"192.168.0.61\",\"port\":9011,\"port_id\":\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"},\"192.168.0.72\":{\"advertised_ip\":\"192.168.0.72\",\"port\":9011,\"port_id\":\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"},\"192.168.0.100\":{\"advertised_ip\":\"192.168.0.100\",\"port\":9011,\"port_id\":\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"}}", "storage_resource_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "storage_spec_code" : "dms.physical.storage.ultra", "service_type" : "advanced", "storage_type" : "hec", "enterprise_project_id" : "0", "is_logical_volume" : true, "extend_times" : 0, "retention_policy" : "produce_reject", "ipv6_enable" : false, "ipv6_connect_addresses" : [ ], "connector_enable" : false, "connector_node_num" : 0, "connector_id" : "", "rest_enable" : false, "rest_connect_address" : "", "kafka_public_status" : "closed", "public_bandwidth" : 0, "message_query_inst_enable" : true, "vpc_client_plain" : false, "support_features" : "kafka.crossvpc.domain.enable,auto.create.topics.enable,rabbitmq.plugin.management,auto_topic_switch,feature.physerver.kafka.user.manager,kafka.ssl.2way.modify.enable,kafka.new.pod.port,message_trace_enable,features.pod.token.access,feature.physerver.kafka.sasl.wildcard,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,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", "trace_enable" : false, "agent_enable" : false, "pod_connect_address" : "100.86.75.15:9080,100.86.142.77:9080,100.86.250.167:9080", "disk_encrypted" : false, "kafka_private_connect_address" : "192.168.0.61:9092,192.168.0.100:9092,192.168.0.72:9092", "enable_auto_topic" : false, "new_spec_billing_enable" : true, "ces_version" : "linux", "port_protocols" : "{\"private_plain_enable\": true,\"private_plain_address\": \"192.xxx.xxx.xxx:9092,192.xxx.xxx.xxx:9092,192.xxx.xxx.xxx:9092\",\"private_sasl_ssl_enable\": true,\"private_sasl_ssl_address\": \"192.xxx.xxx.xxx:9093,192.xxx.xxx.xxx:9093,192.xxx.xxx.xxx:9093\",\"private_sasl_plaintext_enable\": false,\"private_sasl_plaintext_address\": \"\",\"public_plain_enable\": true,\"public_plain_address\": \"100.xxx.xxx.xxx:9094,100.xxx.xxx.xxx:9094,100.xxx.xxx.xxx:9094\",\"public_sasl_ssl_enable\": true,\"public_sasl_ssl_address\": \"100.xxx.xxx.xxx:9095,100.xxx.xxx.xxx:9095,100.xxx.xxx.xxx:9095\",\"public_sasl_plaintext_enable\": false,\"public_sasl_plaintext_address\": \"\"}" }
Status Codes
Status Code |
Description |
---|---|
200 |
Specified instance queried. |
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.