全部产品
Search
文档中心

消息队列Kafka版:GetInstanceList - 查询指定地域的实例信息

更新时间:Nov 22, 2022

调用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****
Tagarray

标签列表。

object
Keystring

资源的标签键。

  • N为1~20。

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

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

test
Valuestring

资源的标签值。

  • N为1~20。

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

  • 最多支持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
InstanceListarray

实例详情。

object
VpcIdstring

VPC ID。

vpc-bp1ojac7bv448nifj****
SpecTypestring

实例规格。取值:

  • professional:专业版(高写版)

  • professionalForHighRead:专业版(高读版)

  • normal:标准版

professional
DeployTypeinteger

部署类型。取值:

  • 4:公网/VPC实例

  • 5:VPC实例

5
CreateTimelong

创建时间。单位:ms。

1577961819000
DiskSizeinteger

磁盘容量。

3600
DiskTypeinteger

磁盘类型。单位:GB。取值:

  • 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

实例状态。取值:

  • 0:待部署

  • 1:部署中

  • 5:服务中

  • 15:已过期

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:后付费

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
Tagsarray

标签。

object
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

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": [
    {
      "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": [
        {
          "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"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-09-13
变更项变更内容
2022-09-13
变更项变更内容
2022-08-03OpenAPI 返回结构发生变更
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-08-02OpenAPI 返回结构发生变更
变更项变更内容
出参OpenAPI 返回结构发生变更
2021-12-20OpenAPI 返回结构发生变更
变更项变更内容
出参OpenAPI 返回结构发生变更
2021-12-20
变更项变更内容