Querying an Instance

Function

This API is used to query the details about an instance.

URI

GET /v1.0/{project_id}/instances/{instance_id}

Table 1 describes the parameters.

**Table 1** Parameters
Parameter	Type	Mandatory	Description
project_id	String	Yes	Project ID.
instance_id	String	Yes	Instance ID.

Request

Request parameters

None.

Example request

None.

Response

Response parameters

Table 2 describes the parameters.

**Table 2** Response parameters
Parameter	Type	Description
name	String	Instance name.
engine	String	Message engine.
engine_version	String	Version of the message engine.
specification	String	Instance specification.
storage_space	Integer	Message storage space. Unit: GB.
partition_num	String	Total number of partitions in a Kafka instance.
used_storage_space	Integer	Used message storage space. Unit: GB
connect_address	String	IP address of an instance.
port	Integer	Port number of an instance.
status	String	Instance status. For details, see Instance Status.
instance_id	String	Instance ID.
resource_spec_code	String	Resource specifications identifier. dms.instance.kafka.cluster.c3.mini: Kafka instance, 100 MB/s reference bandwidth dms.instance.kafka.cluster.c3.small.2: Kafka instance, 300 MB/s reference bandwidth dms.instance.kafka.cluster.c3.middle.2: Kafka instance, 600 MB/s reference bandwidth dms.instance.kafka.cluster.c3.high.2: Kafka instance, 1200 MB/s reference bandwidth
type	String	Instance type. Value: cluster
charging_mode	Integer	Billing mode.
vpc_id	String	ID of a VPC.
vpc_name	String	Name of a VPC.
created_at	String	Time when the 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	Product ID.
security_group_id	String	Security group ID.
security_group_name	String	Security group name.
subnet_id	String	Subnet ID.
subnet_name	String	Subnet name.
subnet_cidr	String	Subnet segment.
available_zones	Array	ID of the AZ to which the instance node belongs. The AZ ID is returned.
user_id	String	User ID.
user_name	String	Username.
access_user	String	Username of an instance.
maintain_begin	String	Time at which a maintenance time window starts. Format: HH:mm:ss
maintain_end	String	Time at which a maintenance time window ends. Format: HH:mm:ss
management_connect_address	String	Connection address of Kafka Manager of the Kafka instance.
ssl_enable	Boolean	Whether security authentication is enabled. true: enable false: disable
enterprise_project_id	String	Enterprise project ID.
is_logical_volume	Boolean	Distinguishes old instances from new instances during instance capacity expansion. true: New instance, which allows dynamic disk capacity expansion without restarting the instance. false: Old instance.
extend_times	Integer	Number of disk expansion times. If it exceeds 20, the disk cannot be expanded.
enable_auto_topic	Boolean	Whether automatic topic creation is enabled. true: enabled false: disabled
total_storage_space	Integer	Message storage space. Unit: GB
storage_resource_id	String	Storage resource ID.
storage_spec_code	String	I/O specification.
service_type	String	Service type.
storage_type	String	Storage type.
retention_policy	String	Message retention policy.
kafka_manager_user	String	Username for logging in to Kafka Manager.
enable_log_collection	Boolean	Whether log collection is enabled.
cross_vpc_info	String	Cross-VPC access information.
ipv6_enable	Boolean	Whether IPv6 is enabled.
ipv6_connect_addresses	Array of strings	IPv6 connection address.
rest_enable	Boolean	Whether the Kafka REST function is enabled.
rest_connect_address	String	Kafka REST connection address.
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.
pod_connect_address	String	Connection address on the tenant side.
disk_encrypted	Boolean	Whether disk encryption is enabled.
kafka_private_connect_address	String	Private connection address of a Kafka instance.
ces_version	String	Cloud Eye version.
tags	Array<Object>	List of tags.

**Table 3** tags
Parameter	Type	Description
key	String	Tag key.
value	String	Tag value.

Example response

{
    "name": "kafka-l00230526",
    "engine": "kafka",
    "port": 9092,
    "status": "RUNNING",
    "type": "cluster",
    "specification": "100MB",
    "engine_version": "XXX",
    "connect_address": "192.168.1.116,192.168.1.152,192.168.1.78",
    "connect_dn": "",
    "instance_id": "ef84dd5f-3ece-4336-8c99-987defd62e3a",
    "resource_spec_code": "dms.instance.kafka.cluster.c3.mini",
    "charging_mode": 1,
    "vpc_id": "2477879f-aebf-496f-a08a-67812885ce9b",
    "vpc_name": "vpc-y00502467",
    "created_at": "1568797295209",
    "product_id": "00300-30308-0--0",
    "security_group_id": "008a08e2-10cc-4d9b-90ab-3f3b8f6c3333",
    "security_group_name": "z00417080-cce-node-na7j",
    "subnet_id": "5ca08fb7-7522-4d95-9fa5-ff6b3592a29d",
    "subnet_name": "subnet-cyd-6102",
    "subnet_cidr": "192.168.1.0/24",
    "available_zones": [
        "ae04cf9d61544df3806a3feeb401b204"
    ],
    "user_id": "2b4af4428ec840dfa1f0f1a32e965567",
    "user_name": "laiyh",
    "kafka_manager_user": "root",
    "maintain_begin": "22:00:00",
    "maintain_end": "02:00:00",
    "storage_space": 492,
    "total_storage_space": 600,
    "used_storage_space": 25,
    "partition_num": "300",
    "ssl_enable": false,
    "management_connect_address": "https://192.168.1.116:9999",
    "storage_resource_id": "81982562-ce8b-490a-95fa-2b225c292271",
    "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_id": "",
    "rest_enable": false,
    "rest_connect_address": "",
    "message_query_inst_enable": true,
    "vpc_client_plain": false,
    "support_features": "feature.physerver.kafka.topic.accesspolicy,message_trace_enable,features.pod.token.access,feature.physerver.kafka.pulbic.dynamic,feature.physerver.kafka.user.manager",
    "trace_enable": false,
    "agent_enable": false,
    "pod_connect_address": "100.113.16.105:9100,100.113.5.197:9100,100.113.15.231:9100",
    "disk_encrypted": false,
    "enable_auto_topic": true
}