GetInstanceList - 查询指定地域的实例信息

名称

类型

描述

示例值

object

Code

integer

返回码。返回 200 代表成功。

200

Message

string

返回信息。

operation success.

RequestId

string

请求 ID。

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

Success

boolean

调用是否成功。

true

InstanceList

array<object>

实例详情。

object

VpcId

string

VPC ID。

vpc-bp1ojac7bv448nifj****

SpecType

string

实例规格。取值：

• professional：专业版（高写版）

• professionalForHighRead：专业版（高读版）

• normal：标准版

professional

DeployType

integer

部署类型。取值：

• 4：公网/VPC 实例

• 5：VPC 实例

5

CreateTime

long

创建时间。单位：ms。

1577961819000

DiskSize

integer

磁盘容量。单位：GB。

3600

DiskType

integer

磁盘类型。取值：

• 0：高效云盘

• 1：SSD

1

SecurityGroup

string

实例的安全组。

• 如果实例是通过云消息队列 Kafka 版控制台或调用StartInstance（调用时没有配置安全组）部署的，则返回值为空。

• 如果实例是通过调用StartInstance（调用时配置了安全组）部署的，则返回值为配置的安全组。

sg-bp13wfx7kz9pkow****

SslEndPoint

string

SSL 接入点的 IP 接入点。云消息队列 Kafka 版实例支持域名接入点和 IP 接入点。

• 域名接入点：由云消息队列 Kafka 版实例域名和端口号拼接而成，格式为{实例域名}:{端口号}。

• IP 接入点：由 Broker 的 IP 地址和端口号拼接而成，格式为{Broker 的 IP 地址}:{端口号}。

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

InstanceId

string

实例 ID。

alikafka_pre-cn-mp919o4v****

AllConfig

string

部署的云消息队列 Kafka 版的当前配置。

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

ServiceStatus

integer

实例状态。取值：

• 0：待部署

• 1：硬件资源准备中

• 2：初始化中

• 3：启动中

• 5：服务中

• 6：迁移中

• 7：准备升级

• 8：升级中

• 9：准备变更

• 10：已释放

• 11：变更中

• 15：已过期

• 30：弹缩中

5

EipMax

integer

公网流量峰值。

20

RegionId

string

实例的地域 ID。

cn-hangzhou

MsgRetain

integer

消息保留时长。单位：小时。

72

VSwitchId

string

vSwitch ID。

vsw-bp1fvuw0ljd7vzmo3****

ExpiredTime

long

到期时间。单位：ms。

1893581018000

TopicNumLimit

integer

Topic 最大数量。

180

ZoneId

string

可用区 ID。

zonei

IoMaxRead

integer

读流量峰值。单位 MB/s .

1000

IoMaxWrite

integer

写流量峰值。单位 MB/s .

1000

IoMax

integer

流量峰值。

20

PaidType

integer

付费类型。取值：

• 0：预付费

• 1：后付费

• 3：Serverless 实例后付费

• 4：Confluent 系列预付费

1

Name

string

实例名称。

alikafka_post-cn-mp91gnw0****

EndPoint

string

默认接入点的 IP 接入点。云消息队列 Kafka 版实例支持域名接入点和 IP 接入点。

• 域名接入点：由云消息队列 Kafka 版实例域名和端口号拼接而成，格式为{实例域名}:{端口号}。

• IP 接入点：由 Broker 的 IP 地址和端口号拼接而成，格式为{Broker 的 IP 地址}:{端口号}。

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

Tags

array<object>

标签。

object

Key

string

标签键。

test

Value

string

标签值。

test

UpgradeServiceDetailInfo

object

实例的升级信息。

Current2OpenSourceVersion

string

实例的开源版本。

2.2.0

DomainEndpoint

string

默认接入点的域名接入点。云消息队列 Kafka 版实例支持域名接入点和 IP 接入点。

• 域名接入点：由云消息队列 Kafka 版实例域名和端口号拼接而成，格式为{实例域名}:{端口号}。

• IP 接入点：由 Broker 的 IP 地址和端口号拼接而成，格式为{Broker 的 IP 地址}:{端口号}。

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

SSL 接入点的域名接入点。云消息队列 Kafka 版实例支持域名接入点和 IP 接入点。

• 域名接入点：由云消息队列 Kafka 版实例域名和端口号拼接而成，格式为{实例域名}:{端口号}。

• IP 接入点：由 Broker 的 IP 地址和端口号拼接而成，格式为{Broker 的 IP 地址}:{端口号}。

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

SASL 接入点的域名接入点。云消息队列 Kafka 版实例支持域名接入点和 IP 接入点。

• 域名接入点：由云消息队列 Kafka 版实例域名和端口号拼接而成，格式为{实例域名}:{端口号}。

• IP 接入点：由 Broker 的 IP 地址和端口号拼接而成，格式为{Broker 的 IP 地址}:{端口号}。

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

资源组 ID。

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

UsedTopicCount

integer

Topic 使用量。

3

UsedGroupCount

integer

Group 使用量。

10

UsedPartitionCount

integer

Partition 使用量。

25

KmsKeyId

string

同地域内的云盘加密的密钥 ID。

0d24xxxx-da7b-4786-b981-9a164dxxxxxx

StandardZoneId

string

标准可用区 id。

cn-hangzhou-k

IoMaxSpec

string

流量规格。

alikafka.hw.2xlarge

ReservedPublishCapacity

integer

预留的发送流量规格值，单位为 MB/s。

60

ReservedSubscribeCapacity

integer

预留的消费流量规格值，单位为 MB/s。

60

ViewInstanceStatusCode

integer

实例状态（新版），与控制台状态同步。

取值：

• 0：待部署

• 1：部署中

• 2：服务中

• 3：已停机

• 4：即将过期

• 5：已过期

• 6：已释放

• 7：升级中

• 8：迁移中

• 21：停机中

• 22：启用中

• 23：释放中

• 30：自动弹缩中

• 101：部署失败

• 102：升级失败

• 103：迁移失败

2

ConfluentConfig

object

若实例为 Confluent 系列实例，才会返回该字段。

KafkaCU

integer

Kafka Broker CPU 核数。

4

KafkaStorage

integer

Kafka Broker 磁盘容量。单位 GB。

800

KafkaReplica

integer

Kafka Broker 副本数量。

3

ZooKeeperCU

integer

ZooKeeper 组件 CPU 核数。

2

ZooKeeperStorage

integer

ZooKeeper 组件磁盘容量。单位 GB。

100

ZooKeeperReplica

integer

ZooKeeper 组件副本数量。

3

ControlCenterCU

integer

ControlCenter 组件 CPU 核数。

4

ControlCenterStorage

integer

ControlCenter 组件磁盘容量。单位 GB。

300

ControlCenterReplica

integer

ControlCenter 组件副本数量。

1

SchemaRegistryCU

integer

SchemaRegistry 组件 CPU 核数。

4

SchemaRegistryReplica

integer

SchemaRegistry 组件副本数量。

2

ConnectCU

integer

Connect 组件 CPU 核数。

4

ConnectReplica

integer

Connect 组件副本数量。

2

KsqlCU

integer

KsqlDB 组件 CPU 核数。

2

KsqlStorage

integer

KsqlDB 组件磁盘容量。单位 GB。

100

KsqlReplica

integer

KsqlDB 组件副本数量。

2

KafkaRestProxyCU

integer

KafkaRestProxy 组件 CPU 核数。

4

KafkaRestProxyReplica

integer

KafkaRestProxy 组件副本数量。

2

Series

string

实例系列标识。返回值有 v2 ，v3，confluent。

v3

名称

类型

取值范围

示例值

描述

enable.vpc_sasl_ssl

Boolean

- true

- false

false

是否开启 VPC 传输加密，如果要开启，必须同时开启 ACL。

kafka.log.retention.hours

Integer

24～480

66

消息保留时长（小时）。

enable.acl

Boolean

- true

- false

false

是否开启 ACL。不支持 2.2.0 以下的实例版本，仅专业版、Serverless 版实例支持开启 ACL。

kafka.message.max.bytes

Integer

1048576～10485760

6291456

最大消息大小（字节）。