文档

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

更新时间:

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
alikafka:ListInstanceRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
RegionIdstring

实例的地域 ID。

cn-hangzhou
OrderIdstring

订单 ID。您可以在阿里云用户中心的订单管理中获取。

6072673****
InstanceIdarray

实例 ID 列表。

string

实例 ID。

alikafka_post-cn-mp91gnw0****
Tagobject []

标签列表。

Keystring

资源的标签键。

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

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

test
Valuestring

资源的标签值。

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

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

test
ResourceGroupIdstring

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

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

返回参数

名称类型描述示例值
object
Codeinteger

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

200
Messagestring

返回信息。

operation success.
RequestIdstring

请求 ID。

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

调用是否成功。

true
InstanceListobject []

实例详情。

VpcIdstring

VPC ID。

vpc-bp1ojac7bv448nifj****
SpecTypestring

实例规格。取值:

  • professional:专业版(高写版)

  • professionalForHighRead:专业版(高读版)

  • normal:标准版

professional
DeployTypeinteger

部署类型。取值:

  • 4:公网/VPC 实例

  • 5:VPC 实例

5
CreateTimelong

创建时间。单位:ms。

1577961819000
DiskSizeinteger

磁盘容量。单位:GB。

3600
DiskTypeinteger

磁盘类型。取值:

  • 0:高效云盘

  • 1:SSD

1
SecurityGroupstring

实例的安全组。

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

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

sg-bp13wfx7kz9pkow****
SslEndPointstring

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
InstanceIdstring

实例 ID。

alikafka_pre-cn-mp919o4v****
AllConfigstring

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

{\"enable.vpc_sasl_ssl\":\"false\",\"kafka.log.retention.hours\":\"66\",\"enable.acl\":\"false\",\"kafka.message.max.bytes\":\"6291456\"}
ServiceStatusinteger
说明 该字段已过时,推荐参考 ViewInstanceStatusCode

实例状态。取值:

  • 0:待部署

  • 1:硬件资源准备中

  • 2:初始化中

  • 3:启动中

  • 5:服务中

  • 6:迁移中

  • 7:准备升级

  • 8:升级中

  • 9:准备变更

  • 10:已释放

  • 11:变更中

  • 15:已过期

  • 30:弹缩中

5
EipMaxinteger

公网流量峰值。

20
RegionIdstring

实例的地域 ID。

cn-hangzhou
MsgRetaininteger

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

72
VSwitchIdstring

vSwitch ID。

vsw-bp1fvuw0ljd7vzmo3****
ExpiredTimelong

到期时间。单位:ms。

1893581018000
TopicNumLimitinteger

Topic 最大数量。

180
ZoneIdstring

可用区 ID。

zonei
IoMaxinteger

流量峰值。

20
PaidTypeinteger

付费类型。取值:

  • 0:预付费

  • 1:后付费

  • 3:V3 系列后付费

  • 4:Confluent 系列预付费

1
Namestring

实例名称。

alikafka_post-cn-mp91gnw0****
EndPointstring

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

  • 域名接入点:由云消息队列 Kafka 版实例域名和端口号拼接而成,格式为{实例域名}:{端口号}
  • IP 接入点:由 Broker 的 IP 地址和端口号拼接而成,格式为{Broker 的 IP 地址}:{端口号}
192.168.XX.XX:9092,192.168.XX.XX:9092,192.168.XX.XX:9092
Tagsobject []

标签。

Keystring

标签键。

test
Valuestring

标签值。

test
UpgradeServiceDetailInfoobject

实例的升级信息。

Current2OpenSourceVersionstring

实例的开源版本。

2.2.0
DomainEndpointstring

默认接入点的域名接入点。云消息队列 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
SslDomainEndpointstring

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
SaslDomainEndpointstring

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
ResourceGroupIdstring

资源组 ID。

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

Topic 使用量。

3
UsedGroupCountinteger

Group 使用量。

10
UsedPartitionCountinteger

Partition 使用量。

25
KmsKeyIdstring

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

0d24xxxx-da7b-4786-b981-9a164dxxxxxx
StandardZoneIdstring

标准可用区 id。

cn-hangzhou-k
IoMaxSpecstring

流量规格。

alikafka.hw.2xlarge
ConfluentConfigobject

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

ReservedPublishCapacityinteger

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

说明 说明 若实例为 V3 系列(Serverless)实例,才会返回该字段。
60
ReservedSubscribeCapacityinteger

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

说明 说明 若实例为 V3 系列(Serverless)实例,才会返回该字段。
60
ViewInstanceStatusCodeinteger

实例状态(新版),与控制台状态同步。

取值:

  • 0:待部署

  • 1:部署中

  • 2:服务中

  • 3:已停机

  • 4:即将过期

  • 5:已过期

  • 6:已释放

  • 7:升级中

  • 8:迁移中

  • 21:停机中

  • 22:启用中

  • 23:释放中

  • 30:自动弹缩中

  • 101:部署失败

  • 102:升级失败

  • 103:迁移失败

2

AllConfig 参数说明

名称类型取值范围示例值描述
enable.vpc_sasl_sslBoolean- true
- false
false是否开启 VPC 传输加密,如果要开启,必须同时开启 ACL。
kafka.log.retention.hoursInteger24~48066消息保留时长(小时)。
enable.aclBoolean- true
- false
false是否开启 ACL。
kafka.message.max.bytesInteger1048576~104857606291456最大消息大小(字节)。

示例

正常返回示例

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",
        "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",
        "ConfluentConfig": {
          "KafkaCU": 0,
          "KafkaStorage": 0,
          "KafkaReplica": 0,
          "ZooKeeperCU": 0,
          "ZooKeeperStorage": 0,
          "ZooKeeperReplica": 0,
          "ControlCenterCU": 0,
          "ControlCenterStorage": 0,
          "ControlCenterReplica": 0,
          "SchemaRegistryCU": 0,
          "SchemaRegistryReplica": 0,
          "ConnectCU": 0,
          "ConnectReplica": 0,
          "KsqlCU": 0,
          "KsqlStorage": 0,
          "KsqlReplica": 0,
          "KafkaRestProxyCU": 0,
          "KafkaRestProxyReplica": 0
        },
        "ReservedPublishCapacity": 60,
        "ReservedSubscribeCapacity": 60,
        "ViewInstanceStatusCode": 2
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-03-25OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2024-03-13OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2024-02-27OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-08-03OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-08-02OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2021-12-20OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈