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

更新时间:2024-12-09 03:44:05

查询指定地域的实例信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用背景高亮的方式表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

操作

访问级别

资源类型

条件关键字

关联操作

alikafka:ListInstance

get

全部资源

*

请求参数

名称

类型

必填

描述

示例值

名称

类型

必填

描述

示例值

RegionId

string

实例的地域 ID。

cn-hangzhou

OrderId

string

订单 ID。您可以在阿里云费用与成本的订购订单中获取。

重要

Serverless 实例暂不支持通过订单 ID 查询。

6072673****

InstanceId

array

实例 ID 列表。

string

实例 ID。

alikafka_post-cn-mp91gnw0****

Tag

array<object>

标签列表。

object

Key

string

资源的标签键。

  • 如果为空,则匹配所有标签键。

  • 最多支持 128 个字符,不能以 aliyun 和 acs:开头,不能包含http://或者https://

test

Value

string

资源的标签值。

  • 标签键为空时,必须为空。如果为空,匹配所有标签值。

  • 最多支持 128 个字符,不能以 aliyun 和 acs:开头,不能包含http://或者https://

test

ResourceGroupId

string

资源组 ID,可通过资源组控制台查询。

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

Series

string

实例系列标识,可根据系列号来过滤不同系列的实例。取值如下:

  • v2

  • v3

  • confluent

v3

返回参数

名称

类型

描述

示例值

名称

类型

描述

示例值

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

说明

该字段已过时,推荐参考 ViewInstanceStatusCode

实例状态。取值:

  • 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。

说明

若实例为 Serverless 实例,才会返回该字段。

60

ReservedSubscribeCapacity

integer

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

说明

若实例为 Serverless 实例,才会返回该字段。

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

AllConfig 参数说明

名称

类型

取值范围

示例值

描述

名称

类型

取值范围

示例值

描述

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

最大消息大小(字节)。

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "operation success.",
  "RequestId": "4B6D821D-7F67-4CAA-9E13-A5A997C3****",
  "Success": true,
  "InstanceList": {
    "InstanceVO": [
      {
        "VpcId": "vpc-bp1ojac7bv448nifj****",
        "SpecType": "professional",
        "DeployType": 5,
        "CreateTime": 1577961819000,
        "DiskSize": 3600,
        "DiskType": 1,
        "SecurityGroup": "sg-bp13wfx7kz9pkow****",
        "SslEndPoint": "192.0.XX.XX:9093,198.51.XX.XX:9093,203.0.XX.XX:9093",
        "InstanceId": "alikafka_pre-cn-mp919o4v****",
        "AllConfig": "{\\\"enable.vpc_sasl_ssl\\\":\\\"false\\\",\\\"kafka.log.retention.hours\\\":\\\"66\\\",\\\"enable.acl\\\":\\\"false\\\",\\\"kafka.message.max.bytes\\\":\\\"6291456\\\"}",
        "ServiceStatus": 5,
        "EipMax": 20,
        "RegionId": "cn-hangzhou",
        "MsgRetain": 72,
        "VSwitchId": "vsw-bp1fvuw0ljd7vzmo3****",
        "ExpiredTime": 1893581018000,
        "TopicNumLimit": 180,
        "ZoneId": "zonei",
        "IoMaxRead": 1000,
        "IoMaxWrite": 1000,
        "IoMax": 20,
        "PaidType": 1,
        "Name": "alikafka_post-cn-mp91gnw0****",
        "EndPoint": "192.168.XX.XX:9092,192.168.XX.XX:9092,192.168.XX.XX:9092",
        "Tags": {
          "TagVO": [
            {
              "Key": "test",
              "Value": "test"
            }
          ]
        },
        "UpgradeServiceDetailInfo": {
          "Current2OpenSourceVersion": "2.2.0"
        },
        "DomainEndpoint": "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": "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": "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": "rg-ac***********7q\n",
        "UsedTopicCount": 3,
        "UsedGroupCount": 10,
        "UsedPartitionCount": 25,
        "KmsKeyId": "0d24xxxx-da7b-4786-b981-9a164dxxxxxx",
        "StandardZoneId": "cn-hangzhou-k",
        "IoMaxSpec": "alikafka.hw.2xlarge",
        "ReservedPublishCapacity": 60,
        "ReservedSubscribeCapacity": 60,
        "ViewInstanceStatusCode": 2,
        "ConfluentConfig": {
          "KafkaCU": 4,
          "KafkaStorage": 800,
          "KafkaReplica": 3,
          "ZooKeeperCU": 2,
          "ZooKeeperStorage": 100,
          "ZooKeeperReplica": 3,
          "ControlCenterCU": 4,
          "ControlCenterStorage": 300,
          "ControlCenterReplica": 1,
          "SchemaRegistryCU": 4,
          "SchemaRegistryReplica": 2,
          "ConnectCU": 4,
          "ConnectReplica": 2,
          "KsqlCU": 2,
          "KsqlStorage": 100,
          "KsqlReplica": 2,
          "KafkaRestProxyCU": 4,
          "KafkaRestProxyReplica": 2
        },
        "Series": "v3"
      }
    ]
  }
}

错误码

错误码请参见公共错误码

变更历史

变更时间

变更内容概要

操作

变更时间

变更内容概要

操作

2024-08-16

OpenAPI 描述信息更新

查看变更详情

2024-04-23

OpenAPI 入参发生变更、OpenAPI 返回结构发生变更

查看变更详情

2024-04-11

OpenAPI 返回结构发生变更

查看变更详情

2024-03-25

OpenAPI 返回结构发生变更

查看变更详情

2024-03-13

OpenAPI 返回结构发生变更

查看变更详情

2024-02-27

OpenAPI 返回结构发生变更

查看变更详情

2022-08-03

OpenAPI 返回结构发生变更

查看变更详情

2022-08-02

OpenAPI 返回结构发生变更

查看变更详情

2021-12-20

OpenAPI 返回结构发生变更

查看变更详情

  • 本页导读 (1)
  • 调试
  • 授权信息
  • 请求参数
  • 返回参数
  • AllConfig 参数说明
  • 示例
  • 错误码
  • 变更历史
AI助理

点击开启售前

在线咨询服务

你好,我是AI助理

可以解答问题、推荐解决方案等