Querying All Instances

Function

This API is used to query the instances of a tenant by set conditions.

URI

GET /v1.0/{project_id}/instances?engine={engine}&name={name}&status={status}&id={id}&includeFailure={includeFailure}&exactMatchName={exactMatchName}

Table 1 describes the parameters.

**Table 1** Parameters
Parameter	Type	Mandatory	Description
project_id	String	Yes	Indicates the ID of a project.
engine	String	No	Indicates the message engine. Value: kafka
name	String	No	Indicates the instance name.
id	String	No	Indicates the instance ID.
status	String	No	Indicates the instance status. For details, see Instance Status.
includeFailure	String	No	Indicates whether to return the number of instances that fail to be created. If the value is true, the number of instances that failed to be created is returned. If the value is not true, the number is not returned.
exactMatchName	String	No	Indicates whether to search for the instance that precisely matches a specified instance name. The default value is false, indicating that a fuzzy search is performed based on a specified instance name. If the value is true, the instance that precisely matches a specified instance name is queried.
enterprise_project_id	String	No	Indicates the enterprise project ID.

Example

GET /v1.0/bd6b78e2ff9e4e47bc260803ddcc7a21/instances?start=1&limit=10&name=&status=&id=&includeFailure=true&exactMatchName=false

Request

Request parameters

None.

Example request

None.

Response

Response parameters

Table 2 describes the parameters.

**Table 2** Response parameters
Parameter	Type	Description
instances	Array	Indicates instance details.
instance_num	Integer	Indicates the number of instances.

**Table 3** instance parameter description
Parameter	Type	Description
name	String	Indicates the instance name.
engine	String	Indicates the message engine.
engine_version	String	Indicates the engine version.
specification	String	Indicates the specifications of an instance.
storage_space	Integer	Indicates the message storage space. Unit: GB
partition_num	Integer	Indicates the maximum number of topics in a Kafka instance.
used_storage_space	Integer	Indicates the used message storage space. Unit: GB
connect_address	String	Indicates the IP address of an instance.
port	Integer	Indicates the port number of an instance.
status	String	Indicates the status of an instance. For details, see Instance Status.
instance_id	String	Indicates the instance ID.
resource_spec_code	String	Indicates the 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 reference bandwidth dms.instance.kafka.cluster.c3.high.2: Kafka instance, 1200 MB reference bandwidth
charging_mode	Integer	Indicates the billing mode.
vpc_id	String	Indicates the ID of a VPC.
vpc_name	String	Indicates the name of a VPC.
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.
user_id	String	Indicates the user ID.
user_name	String	Indicates the username.
maintain_begin	String	Indicates the time at which a maintenance time window starts. Format: HH:mm:ss
maintain_end	String	Time at which the maintenance time window ends. Format: HH:mm:ss
enterprise_project_id	String	Indicates the 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	String	Indicates the number of disk expansion times. If it exceeds 20, the disk cannot be expanded.
enable_auto_topic	Boolean	Indicates whether automatic topic creation is enabled. true: enabled false: disabled
type	String	Indicates the instance type. Value: cluster.
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.
available_zones	Array	Indicates the AZ to which the instance node belongs. The AZ ID is returned.
total_storage_space	Integer	Indicates the message storage space. Unit: GB
storage_resource_id	String	Indicates the storage resource ID.
storage_spec_code	String	Indicates the I/O specification.
service_type	String	Indicates the service type.
storage_type	String	Indicates the storage type.
retention_policy	String	Indicates the message retention policy.

Example response

{
    "instances": [
        {
            "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",
            "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",
            "available_zones": [
                "ae04cf9d61544df3806a3feeb401b204"
            ],
            "user_id": "2b4af4428ec840dfa1f0f1a32e965567",
            "user_name": "laiyh",
            "kafka_manager_user": "root",
            "maintain_begin": "22:00",
            "maintain_end": "02: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": [],
            "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
        }
    ],
    "instance_num": 1
}