Listing All Instances

project_id

Yes

String

Definition

Project ID. For details, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

engine

Yes

String

Definition:

Message engine.

Constraints:

N/A

Range:

Kafka

Default Value:

N/A

name

No

String

Definition:

Instance name.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

instance_id

No

String

Definition:

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

status

No

String

Definition

Instance status. For details, see Instance Status.

Constraints

N/A

Range

N/A

Default Value

N/A

include_failure

No

String

Definition:

Whether to return the number of instances that fail to be created.

Constraints:

N/A

Range:

• 'true': Yes

• 'false': No

Default Value:

N/A

exact_match_name

No

String

Definition:

Whether to search for the instance that precisely matches a specified instance name.

Constraints:

N/A

Range:

• 'true': Yes

• 'false': No

Default Value:

'false'

enterprise_project_id

No

String

Definition:

Enterprise project ID.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

offset

No

String

Definition:

Offset where the query starts.

Constraints:

N/A

Range:

≥ 0

Default Value:

N/A

limit

No

String

Definition:

Maximum number of instances that can be returned in a query.

Constraints:

N/A

Range:

1–50

Default Value:

10.

instances

Array of ShowInstanceResp objects

Definition:

Instance list.

instance_num

Integer

Definition:

Number of instances.

Range:

N/A

name

String

Definition:

Instance name.

Range:

N/A

engine

String

Definition:

Engine.

Range:

kafka

engine_version

String

Definition

Kafka version.

Range

• 2.7

• 3.x

description

String

Definition:

Instance description.

Range:

N/A

specification

String

Definition:

Instance specification.

Range:

N/A

storage_space

Integer

Definition

Message storage space, in GB.

Range

• 300–300,000 GB for c6.2u4g.cluster Kafka instances

• 300–600,000 GB for c6.4u8g.cluster Kafka instances

• 300–1,500,000 GB for c6.8u16g.cluster Kafka instances

• 300–1,500,000 GB for c6.12u24g.cluster Kafka instances

• 300–1,500,000 GB for c6.16u32g.cluster Kafka instances

• 300–300,000 GB for kafka.2u4g.cluster.small Kafka instances

partition_num

String

Definition:

Number of partitions in a Kafka instance.

Range:

N/A

used_storage_space

Integer

Definition:

Used message storage space, in GB.

Range:

N/A

dns_enable

Boolean

Definition:

Whether to enable domain name access to an instance.

Range:

• true: Yes

• false: No

connect_address

String

Definition:

Instance IP address.

Range:

N/A

port

Integer

Definition:

Instance port.

Range:

N/A

status

String

Definition:

Status of an instance. For details, see Instance Status.

Range:

N/A

instance_id

String

Definition:

Instance ID.

Range:

N/A

resource_spec_code

String

Definition:

Resource specification ID.

Range:

• 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

Definition

Billing mode.

Range

• 1 indicates pay-per-use billing

and - 0 indicates yearly/monthly billing.

vpc_id

String

Definition:

VPC ID.

Range:

N/A

vpc_name

String

Definition:

VPC name.

Range:

N/A

created_at

String

Definition:

Time when creation is complete.

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.

Range:

N/A

subnet_name

String

Definition:

Subnet name.

Range:

N/A

subnet_cidr

String

Definition:

Subnet CIDR block.

Range:

N/A

user_id

String

Definition:

User ID.

Range:

N/A

user_name

String

Definition:

Username.

Range:

N/A

access_user

String

Definition:

Username for accessing an instance.

Range:

N/A

order_id

String

Definition:

Indicates an order ID. This parameter has a value only when the billing mode is yearly/monthly mode.

Range:

N/A

maintain_begin

String

Definition:

Time at which the maintenance window starts. The format is HH:mm:ss.

Range:

N/A

maintain_end

String

Definition:

Time at which the maintenance window ends. The format is HH:mm:ss.

Range:

N/A

enable_publicip

Boolean

Definition:

Indicates whether public access is enabled for an instance.

Range:

• true: Yes

• false: No

management_connect_address

String

Definition:

Indicates the connection address of the Kafka Manager of a Kafka instance.

Range:

N/A

ssl_enable

Boolean

Definition:

Whether security authentication is enabled.

Range:

• true: Yes

• false: No

broker_ssl_enable

Boolean

Definition:

Indicates whether to enable encrypted replica transmission among brokers.

Range:

• true: Yes

• false: No

kafka_security_protocol

String

Definition

Security protocol used by Kafka.

If port_protocols is not 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.

Range

• PLAINTEXT: No SSL certificate is used for encrypted transmission, and username and password authentication is not supported. This mode provides better performance but lower security. Do not use this mode for public access in a production environment.

• 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 uses the SCRAM-SHA-512 mechanism and delivers high performance.

sasl_enabled_mechanisms

Array of strings

Definition:

Authentication mechanism used after SASL is enabled.

ssl_two_way_enable

Boolean

Definition

Whether to enable two-way authentication.

Range

• true: Yes

• false: No

cert_replaced

Boolean

Definition

Whether to enable certificate replacement.

Range

• true: Yes

• false: No

public_management_connect_address

String

Definition

Address for accessing Kafka Manager over public networks.

Range

N/A

enterprise_project_id

String

Definition:

Enterprise project ID.

Range:

N/A

is_logical_volume

Boolean

Definition:

Distinguishes old instances from new instances during instance capacity expansion.

Range:

• true: New instance, which allows dynamic disk capacity expansion without restarting the instance.

• false: Old instance.

extend_times

Integer

Definition

Times of scaling up the instance disk.

Range

N/A

enable_auto_topic

Boolean

Definition

Whether to enable automatic topic creation.

Range

• true: Yes

• false: No

type

String

Definition:

Instance type.

Range:

• single: single-node

• cluster: cluster

product_id

String

Definition:

Product ID.

Range:

N/A

security_group_id

String

Definition:

Security group ID.

Range:

N/A

security_group_name

String

Definition:

Security group name.

Range:

N/A

subnet_id

String

Definition:

Subnet ID.

Range:

N/A

available_zones

Array of strings

Definition:

Indicates the ID of the AZ to which the instance node belongs. The AZ ID is returned.

available_zone_names

Array of strings

Definition:

Indicates the AZ name to which the instance node belongs. The AZ name is returned.

total_storage_space

Integer

Definition:

Total message storage space, in GB.

Range:

N/A

public_connect_address

String

Definition:

Instance IP address for public access. This parameter is available only when public access is enabled for the instance.

Range:

N/A

public_connect_domain_name

String

Definition:

Instance domain name for public access. This parameter is available only when public access is enabled for the instance.

Range:

N/A

storage_resource_id

String

Definition:

Storage resource ID.

Range:

N/A

storage_spec_code

String

Definition:

I/O specification.

Range:

N/A

service_type

String

Definition

Service type.

Range

advanced

storage_type

String

Definition

Storage type.

Range

hec

retention_policy

String

Definition:

Message retention policy.

Range:

• time_base: The earliest messages are deleted.

• produce_reject: New messages cannot be created.

kafka_public_status

String

Definition:

Whether Kafka public access is enabled.

Range:

• true: enabled.

• closed: disabled.

• false: not used.

• freezed: frozen.

• actived: unfrozen.

public_bandwidth

Integer

Definition:

Public network access bandwidth.

Range:

N/A

enable_log_collection

Boolean

Definition:

Whether log collection is enabled.

Range:

• true: Yes

• false: No

new_auth_cert

Boolean

Definition:

Indicates whether to enable a new certificate.

Range:

• true: Yes

• false: No

cross_vpc_info

Map<String,CrossVpcInfoEntity>

Definition:

Cross-VPC access information.

Range:

N/A

public_cross_vpc_info

Map<String,CrossVpcInfoEntity>

Definition

Public network cross-VPC access information.

Range

N/A

ipv6_enable

Boolean

Definition:

Whether IPv6 is enabled.

Range:

• true: Yes

• false: No

ipv6_connect_addresses

Array of strings

Definition:

IPv6 connection address.

connector_enable

Boolean

Definition:

Indicates whether dumping is enabled.

Range:

• true: Yes

• false: No

connector_node_num

Integer

Definition:

Number of connectors.

Range:

2–16

connector_id

String

Definition:

Dumping task ID.

Range:

N/A

rest_enable

Boolean

Definition:

Indicates whether the Kafka REST function is enabled.

Range:

• true: Yes

• false: No

rest_connect_address

String

Definition:

Indicates the Kafka REST connection address.

Range:

N/A

public_boundwidth

Integer

Definition:

Public network access bandwidth. To be deleted.

Range:

N/A

message_query_inst_enable

Boolean

Definition:

Indicates whether message query is enabled.

Range:

• true: Yes

• false: No

vpc_client_plain

Boolean

Definition:

Indicates whether intra-VPC plaintext access is enabled.

Range:

• true: Yes

• false: No

support_features

String

Definition:

Indicates the list of features supported by the Kafka instance.

Range:

N/A

trace_enable

Boolean

Definition:

Indicates whether message tracing is enabled.

Range:

• true: Yes

• false: No

agent_enable

Boolean

Definition:

Indicates whether the proxy is enabled.

Range:

• true: Yes

• false: No

pod_connect_address

String

Definition:

Indicates the connection address on the tenant side.

Range:

N/A

disk_encrypted

Boolean

Definition:

Whether disk encryption is enabled.

Range:

• true: Yes

• false: No

disk_encrypted_key

String

Definition:

Disk encryption key. If disk encryption is not enabled, this parameter is left blank.

Range:

N/A

kafka_private_connect_address

String

Definition:

Indicates the private connection address of a Kafka instance.

Range:

N/A

kafka_private_connect_domain_name

String

Definition:

Indicates the private domain name of a Kafka instance.

Range:

N/A

ces_version

String

Definition:

Cloud Eye version.

Range:

N/A

public_access_enabled

String

Definition:

Time when public access was enabled for an instance.

Range:

• true: already enabled.

• actived: already enabled.

• closed: already disabled.

• false: already disabled.

node_num

Integer

Definition:

Number of nodes.

Range:

• 1: number of nodes of a single-node Kafka instance.

• 3–50: number of nodes of a cluster Kafka instance.

port_protocols

PortProtocolsEntity object

Definition:

Connection modes and addresses supported by an instance.

enable_acl

Boolean

Definition:

Indicates whether access control is enabled.

Range:

• true: Yes

• false: No

new_spec_billing_enable

Boolean

Definition:

Whether billing based on new specifications is enabled.

Range:

• true: Yes

• false: No

broker_num

Integer

Definition:

Number of nodes.

Range:

N/A

tags

Array of TagEntity objects

Definition:

Tag list.

dr_enable

Boolean

Definition:

Whether DR is enabled.

Range:

• true: Yes

• false: No

advertised_ip

String

Definition

IP address.

Range

N/A

port

Integer

Definition

Port.

Range

N/A

port_id

String

Definition

Port ID.

Range

N/A

private_plain_enable

Boolean

Definition:

Whether private plaintext access is supported by an instance.

Range:

• true: Yes

• false: No

private_plain_address

String

Definition

Connection addresses of Kafka private plaintext access.

Range

N/A

private_plain_domain_name

String

Definition:

Private plaintext connection domain name.

Range:

N/A

private_sasl_ssl_enable

Boolean

Definition:

Whether the instance supports private SASL_SSL access.

Range:

• true: Yes

• false: No

private_sasl_ssl_address

String

Definition

Connection addresses of the Kafka private SASL_SSL access mode.

Range

N/A

private_sasl_ssl_domain_name

String

Definition:

Private SASL_SSL connection domain name.

Range:

N/A

private_sasl_plaintext_enable

Boolean

Definition:

Whether the instance supports private SASL_PLAINTEXT access.

Range:

• true: Yes

• false: No

private_sasl_plaintext_address

String

Definition

Connection addresses of the Kafka private SASL_PLAINTEXT access mode.

Range

N/A

private_sasl_plaintext_domain_name

String

Definition:

Private SASL_PLAINTEXT connection domain name.

Range:

N/A

public_plain_enable

Boolean

Definition:

Whether the instance supports public plaintext access.

Range:

• true: Yes

• false: No

public_plain_address

String

Definition

Connection addresses of Kafka public plaintext access.

Range

N/A

public_plain_domain_name

String

Definition:

Public plaintext connection domain name.

Range:

N/A

public_sasl_ssl_enable

Boolean

Definition:

Whether the instance supports public SASL_SSL access.

Range:

• true: Yes

• false: No

public_sasl_ssl_address

String

Definition

Connection addresses of the Kafka public SASL_SSL access mode.

Range

N/A

public_sasl_ssl_domain_name

String

Definition:

Public SASL_SSL connection domain name.

Range:

N/A

public_sasl_plaintext_enable

Boolean

Definition:

Whether the instance supports public SASL_PLAINTEXT access.

Range:

• true: Yes

• false: No

public_sasl_plaintext_address

String

Definition

Connection addresses of the Kafka public SASL_PLAINTEXT access mode.

Range

N/A

public_sasl_plaintext_domain_name

String

Definition:

Public SASL_PLAINTEXT connection domain name.

Range:

N/A

key

String

Definition:

Tag key.

Constraints:

• Cannot be left blank.

• Must be unique for the same instance.

• Can contain 1 to 128 characters.

• Can contain letters, digits, spaces, and special characters _.:=+-@

• Cannot start with sys

• Cannot start or end with a space.

Range:

N/A

Default Value:

N/A

value

String

Definition:

Tag value.

Constraints:

• Can contain 0 to 255 characters.

• Can contain letters, digits, spaces, and special characters _.:=+-@

Range:

N/A

Default Value:

N/A

200

Instance list queried.