Listing All Instances

project_id

Yes

String

Project ID. For details about how to obtain it, see Obtaining a Project ID.

engine

No

String

Message engine. Value: kafka.

Default: kafka

name

No

String

Instance name.

instance_id

No

String

Instance ID.

status

No

String

Instance status. For details, see Instance Status.

include_failure

No

String

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.

exact_match_name

No

String

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

No

String

Enterprise project ID.

offset

No

String

Offset, which is the position where the query starts. The value must be greater than or equal to 0.

limit

No

String

Maximum number of instances returned in the current query. The default value is 10. The value ranges from 1 to 50.

instances

Array of ShowInstanceResp objects

Instance list.

instance_num

Integer

Number of instances.

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.

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 specification code.

• dms.instance.kafka.cluster.c3.mini: Kafka instance with 100 MB/s bandwidth

• dms.instance.kafka.cluster.c3.small.2: Kafka instance with 300 MB/s bandwidth

• dms.instance.kafka.cluster.c3.middle.2: Kafka instance with 600 MB/s bandwidth

• dms.instance.kafka.cluster.c3.high.2: Kafka instance with 1200 MB/s bandwidth

charging_mode

Integer

Billing mode. This parameter is currently not used.

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.

• true: enabled

• false: disabled

management_connect_address

String

Connection address of Kafka Manager of the Kafka instance.

ssl_enable

Boolean

Whether security authentication is enabled.

• true: enable

• false: disabled

kafka_security_protocol

String

Security protocol used after SASL is enabled.

• SASL_SSL: Data is encrypted with SSL certificates for high-security transmission.

• SASL_PLAINTEXT: Data is transmitted in plaintext with username and password authentication. This protocol only uses the SCRAM-SHA-512 mechanism and delivers high performance.

sasl_enabled_mechanisms

Array of strings

Authentication mechanism used after SASL is enabled.

• PLAIN: simple username and password verification.

• SCRAM-SHA-512: user credential verification, which is more secure than PLAIN.

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.

• 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 the value exceeds 20, disk expansion is no longer allowed.

enable_auto_topic

Boolean

Whether automatic topic creation is enabled.

• true: enabled

• false: disabled

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.

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.

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.

kafka_manager_enable

Boolean

Whether Kafka Manager is enabled.

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.

connector_enable

Boolean

Whether dumping is enabled. Dumping is not supported for the new specification type.

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.

ces_version

String

Cloud Eye version.

public_access_enabled

String

Time when public access was enabled for an instance. The value can be true, actived, closed, or false.

node_num

Integer

Node quantity.

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.

key

String

Key.

A key can contain 1 to 128 characters.

Include UTF-8 letters, digits, spaces, or the following special characters _.:=+-@

Do not use spaces to start or end the key.

value

String

Value.

A value can contain 0 to 255 characters.

Include UTF-8 letters, digits, spaces, or the following special characters _.:/=+-@

A value can be an empty string.

200

Response example: