GetInstanceList - Query instance information in a specified region

Name

Type

Description

Example

object

Code

integer

The return code. A value of 200 indicates that the request was successful.

200

Message

string

The returned message.

operation success.

RequestId

string

The request ID.

4B6D821D-7F67-4CAA-9E13-A5A997C3****

Success

boolean

Indicates whether the call was successful.

true

InstanceList

array<object>

The instance details.

object

VpcId

string

The VPC ID.

vpc-bp1ojac7bv448nifj****

SpecType

string

The instance type. Valid values:

• professional: Professional Edition (High-write)

• professionalForHighRead: Professional Edition (High-read)

• normal: Standard Edition

professional

DeployType

integer

The deployment type. Valid values:

• 4: Internet and VPC instance

• 5: VPC instance

5

CreateTime

long

The time when the instance was created. Unit: ms.

1577961819000

DiskSize

integer

The disk capacity. Unit: GB.

3600

DiskType

integer

The disk type. Valid values:

• 0: ultra disk

• 1: SSD

1

SecurityGroup

string

The security group of the instance.

• If the instance was deployed in the ApsaraMQ for Kafka console or by calling the StartInstance operation without configuring a security group, this parameter is empty.

• If the instance was deployed by calling the StartInstance operation and a security group was configured, the value of this parameter is the configured security group.

sg-bp13wfx7kz9pkow****

SslEndPoint

string

The IP endpoint for SSL access. ApsaraMQ for Kafka instances support domain name endpoints and IP endpoints.

• Domain name endpoint: The instance domain name and port number. Format: {Instance domain name}:{Port number}.

• IP endpoint: The IP address of the broker and the port number. Format: {IP address of the broker}:{Port number}.

192.0.XX.XX:9093,198.51.XX.XX:9093,203.0.XX.XX:9093

InstanceId

string

The instance ID.

alikafka_pre-cn-mp919o4v****

AllConfig

string

The current configuration of the deployed ApsaraMQ for Kafka instance.

{\"enable.vpc_sasl_ssl\":\"false\",\"kafka.log.retention.hours\":\"66\",\"enable.acl\":\"false\",\"kafka.message.max.bytes\":\"6291456\"}

ServiceStatus

integer

The instance status. Valid values:

• 0: Pending deployment

• 1: Preparing hardware resources

• 2: initializing

• 3: Starting

• 5: in service

• 6: Migrating

• 7: Preparing for upgrade

• 8: Upgrading

• 9: Preparing for change

• 10: Released

• 11: Changing

• 15: expired

• 30: Scaling

5

EipMax

integer

The peak Internet traffic.

20

RegionId

string

The region ID of the instance.

cn-hangzhou

MsgRetain

integer

The message retention period. Unit: hours.

72

VSwitchId

string

The vSwitch ID.

vsw-bp1fvuw0ljd7vzmo3****

ExpiredTime

long

The expiration time. Unit: ms.

1893581018000

TopicNumLimit

integer

The maximum number of topics.

180

ZoneId

string

The zone ID.

zonei

IoMaxRead

integer

The peak read traffic. Unit: MB/s.

1000

IoMaxWrite

integer

The peak write traffic. Unit: MB/s.

1000

IoMax

integer

The peak traffic.

20

PaidType

integer

The billing method. Valid values:

• 0: subscription

• 1: pay-as-you-go

• 3: pay-as-you-go for Serverless instances

• 4: subscription for Confluent series

1

Name

string

The instance name.

alikafka_post-cn-mp91gnw0****

EndPoint

string

The IP endpoint for default access. ApsaraMQ for Kafka instances support domain name endpoints and IP endpoints.

• Domain name endpoint: The instance domain name and port number. Format: {Instance domain name}:{Port number}.

• IP endpoint: The IP address of the broker and the port number. Format: {IP address of the broker}:{Port number}.

192.168.XX.XX:9092,192.168.XX.XX:9092,192.168.XX.XX:9092

Tags

array<object>

The tags.

object

Key

string

The tag key.

test

Value

string

The tag value.

test

UpgradeServiceDetailInfo

object

The upgrade information of the instance.

Current2OpenSourceVersion

string

The open source version of the instance.

2.2.0

DomainEndpoint

string

The domain name endpoint for default access. ApsaraMQ for Kafka instances support domain name endpoints and IP endpoints.

• Domain name endpoint: The instance domain name and port number. Format: {Instance domain name}:{Port number}.

• IP endpoint: The IP address of the broker and the port number. Format: {IP address of the broker}:{Port number}.

alikafka-pre-cn-zv**********-1-vpc.alikafka.aliyuncs.com:9092,alikafka-pre-cn-zv**********-2-vpc.alikafka.aliyuncs.com:9092,alikafka-pre-cn-zv**********-3-vpc.alikafka.aliyuncs.com:9092

SslDomainEndpoint

string

The domain name endpoint for SSL access. ApsaraMQ for Kafka instances support domain name endpoints and IP endpoints.

• Domain name endpoint: The instance domain name and port number. Format: {Instance domain name}:{Port number}.

• IP endpoint: The IP address of the broker and the port number. Format: {IP address of the broker}:{Port number}.

alikafka-pre-cn-zv**********-1.alikafka.aliyuncs.com:9093,alikafka-pre-cn-zv**********-2.alikafka.aliyuncs.com:9093,alikafka-pre-cn-zv**********-3.alikafka.aliyuncs.com:9093

SaslDomainEndpoint

string

The domain name endpoint for SASL access. ApsaraMQ for Kafka instances support domain name endpoints and IP endpoints.

• Domain name endpoint: The instance domain name and port number. Format: {Instance domain name}:{Port number}.

• IP endpoint: The IP address of the broker and the port number. Format: {IP address of the broker}:{Port number}.

alikafka-pre-cn-zv**********-1-vpc.alikafka.aliyuncs.com:9094,alikafka-pre-cn-zv**********-2-vpc.alikafka.aliyuncs.com:9094,alikafka-pre-cn-zv**********-3-vpc.alikafka.aliyuncs.com:9094

ResourceGroupId

string

The resource group ID.

rg-ac***********7q

UsedTopicCount

integer

The number of topics in use.

3

UsedGroupCount

integer

The number of groups in use.

10

UsedPartitionCount

integer

The number of partitions in use.

25

KmsKeyId

string

The ID of the key for disk encryption in the same region.

0d24xxxx-da7b-4786-b981-9a164dxxxxxx

StandardZoneId

string

The standard zone ID.

cn-hangzhou-k

IoMaxSpec

string

The traffic specification.

alikafka.hw.2xlarge

ReservedPublishCapacity

integer

The reserved capacity for message sending. Unit: MB/s.

60

ReservedSubscribeCapacity

integer

The reserved traffic consumption rate, in MB/s.

60

ViewInstanceStatusCode

integer

The instance status (new version), which is synchronized with the console.

Valid values:

• 0: Pending deployment

• 1: Deploying

• 2: in service

• 3: Stopped

• 4: Expiring

• 5: expired

• 6: Released

• 7: Upgrading

• 8: Migrating

• 21: Stopping

• 22: Starting

• 23: Releasing

• 30: Auto-scaling

• 101: Deployment failed

• 102: Upgrade failed

• 103: Migration failed

2

ConfluentConfig

object

This parameter is returned only for Confluent series instances.

KafkaCU

integer

The number of CPU cores for the Kafka broker.

4

KafkaStorage

integer

The disk capacity of the Kafka broker. Unit: GB.

800

KafkaReplica

integer

The number of replicas for the Kafka broker.

3

ZooKeeperCU

integer

The number of CPU cores for the ZooKeeper component.

2

ZooKeeperStorage

integer

The disk capacity of the ZooKeeper component. Unit: GB.

100

ZooKeeperReplica

integer

The number of replicas for the ZooKeeper component.

3

ControlCenterCU

integer

The number of CPU cores for the Control Center component.

4

ControlCenterStorage

integer

The disk capacity of the Control Center component. Unit: GB.

300

ControlCenterReplica

integer

The number of replicas for the Control Center component.

1

SchemaRegistryCU

integer

The number of CPU cores for the Schema Registry component.

4

SchemaRegistryReplica

integer

The number of replicas for the Schema Registry component.

2

ConnectCU

integer

The number of CPU cores for the Connect component.

4

ConnectReplica

integer

The number of replicas for the Connect component.

2

KsqlCU

integer

The number of CPU cores for the KsqlDB component.

2

KsqlStorage

integer

The disk capacity of the KsqlDB component. Unit: GB.

100

KsqlReplica

integer

The number of replicas for the KsqlDB component.

2

KafkaRestProxyCU

integer

The number of CPU cores for the Kafka Rest Proxy component.

4

KafkaRestProxyReplica

integer

The number of replicas for the Kafka Rest Proxy component.

2

Series

string

The instance edition. Valid values: v2, v3, and confluent.

v3

Name

Type

Value range

Example value

Description

enable.vpc_sasl_ssl

Boolean

- true

- false

false

Indicates whether to enable encryption in transit for VPCs. If you enable this feature, you must also enable access control lists (ACLs).

kafka.log.retention.hours

Integer

24 to 480

66

The message retention period in hours.

enable.acl

Boolean

- true

- false

false

Indicates whether to enable ACLs. This feature is not supported for instances of versions earlier than 2.2.0. Only Professional Edition and Serverless instances support ACLs.

kafka.message.max.bytes

Integer

1048576 to 10485760

6291456

The maximum message size in bytes.