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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String GetInstanceList

系统规定参数。取值:GetInstanceList

RegionId String cn-hangzhou

实例的地域ID。

OrderId String 20816072673****

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

InstanceId.N String alikafka_post-cn-mp91gnw0p***

实例ID。

Tag.N.Key String test

资源的标签键。

  • N为1~20。
  • 如果为空,则匹配所有标签键。
  • 最多支持128个字符,不能以aliyun和acs:开头,不能包含http://或者https://。
Tag.N.Value String test

资源的标签值。

  • N为1~20。
  • 标签键为空时,必须为空。如果为空,匹配所有标签值。
  • 最多支持128个字符,不能以aliyun和acs:开头,不能包含http://或者https://。

返回数据

名称 类型 示例值 描述
Code Integer 200

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

Message String operation success.

返回信息。

RequestId String 4B6D821D-7F67-4CAA-9E13-A5A997C35***

请求ID。

Success Boolean true

调用是否成功。

InstanceList Array of InstanceVO

实例详情。

InstanceVO
VpcId String vpc-bp1ojac7bv448nifjl***

VPC ID。

SpecType String professional

实例规格。取值:

  • professional:专业版(高写版)
  • professionalForHighRead:专业版(高读版)
  • normal:标准版
DeployType Integer 5

部署类型。取值:

  • 4:公网/VPC实例
  • 5:VPC实例
CreateTime Long 1577961819000

创建时间。

DiskSize Integer 3600

磁盘容量。

DiskType Integer 1

磁盘类型。取值:

  • 0:高效云盘
  • 1:SSD
SecurityGroup String sg-bp13wfx7kz9pkowc***

实例的安全组。

  • 如果实例是通过消息队列Kafka版控制台或调用StartInstance(调用时没有配置安全组)部署的,则返回值为空。
  • 如果实例是通过调用StartInstance(调用时配置了安全组)部署的,则返回值为配置的安全组。
SslEndPoint String 192.0.2.XX:9093,198.51.100.XX:9093,203.0.113.XX:9093

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

  • 域名接入点:由消息队列Kafka版实例域名和端口号拼接而成,格式为{实例域名}:{端口号}
  • IP接入点:由Broker的IP地址和端口号拼接而成,格式为{Broker的IP地址}:{端口号}
InstanceId String alikafka_pre-cn-mp919o4v****

实例ID。

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

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

ServiceStatus Integer 5

实例状态。取值:

  • 0:待部署
  • 1:部署中
  • 5:服务中
  • 15:已过期
EipMax Integer 20

公网流量峰值。

RegionId String cn-hangzhou

实例的地域ID。

MsgRetain Integer 72

消息保留时长。

VSwitchId String vsw-bp1fvuw0ljd7vzmo3d***

vSwitch ID。

ExpiredTime Long 1893581018000

到期时间。

TopicNumLimit Integer 180

Topic最大数量。

ZoneId String zonei

可用区ID。

IoMax Integer 20

流量峰值。

PaidType Integer 1

付费类型。取值:

  • 0:预付费
  • 1:后付费
Name String alikafka_post-cn-mp91gnw0p***

实例名称。

EndPoint String 192.168.0.XX:9092,192.168.0.XX:9092,192.168.0.XX:9092

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

  • 域名接入点:由消息队列Kafka版实例域名和端口号拼接而成,格式为{实例域名}:{端口号}
  • IP接入点:由Broker的IP地址和端口号拼接而成,格式为{Broker的IP地址}:{端口号}
Tags Array of TagVO

标签。

TagVO
Key String test

标签键。

Value String test

标签值。

UpgradeServiceDetailInfo Object

实例的升级信息。

Current2OpenSourceVersion String 2.2.0

实例的开源版本。

DomainEndpoint String 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

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

  • 域名接入点:由消息队列Kafka版实例域名和端口号拼接而成,格式为{实例域名}:{端口号}
  • IP接入点:由Broker的IP地址和端口号拼接而成,格式为{Broker的IP地址}:{端口号}
SslDomainEndpoint String 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

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

  • 域名接入点:由消息队列Kafka版实例域名和端口号拼接而成,格式为{实例域名}:{端口号}
  • IP接入点:由Broker的IP地址和端口号拼接而成,格式为{Broker的IP地址}:{端口号}
SaslDomainEndpoint String 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

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

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

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。

kafka.message.max.bytes

Integer

1048576~10485760

6291456

最大消息大小(字节)。

示例

请求示例

http(s)://alikafka.cn-hangzhou.aliyuncs.com/?Action=GetInstanceList
&RegionId=cn-hangzhou
&OrderId=20816072673****
&InstanceId=["alikafka_post-cn-mp91gnw0p***"]
&Tag=[{"Key":"test","Value":"test"}]
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<GetInstanceListResponse>
    <Code>200</Code>
    <Message>operation success.</Message>
    <RequestId>4B6D821D-7F67-4CAA-9E13-A5A997C35***</RequestId>
    <Success>true</Success>
    <InstanceList>
        <VpcId>vpc-bp1ojac7bv448nifjl***</VpcId>
        <SpecType>professional</SpecType>
        <DeployType>5</DeployType>
        <CreateTime>1577961819000</CreateTime>
        <DiskSize>3600</DiskSize>
        <DiskType>1</DiskType>
        <SecurityGroup>sg-bp13wfx7kz9pkowc***</SecurityGroup>
        <SslEndPoint>192.0.2.XX:9093,198.51.100.XX:9093,203.0.113.XX:9093</SslEndPoint>
        <InstanceId>alikafka_pre-cn-mp919o4v****</InstanceId>
        <AllConfig>{\"enable.vpc_sasl_ssl\":\"false\",\"kafka.log.retention.hours\":\"66\",\"enable.acl\":\"false\",\"kafka.message.max.bytes\":\"6291456\"}</AllConfig>
        <ServiceStatus>5</ServiceStatus>
        <EipMax>20</EipMax>
        <RegionId>cn-hangzhou</RegionId>
        <MsgRetain>72</MsgRetain>
        <VSwitchId>vsw-bp1fvuw0ljd7vzmo3d***</VSwitchId>
        <ExpiredTime>1893581018000</ExpiredTime>
        <TopicNumLimit>180</TopicNumLimit>
        <ZoneId>zonei</ZoneId>
        <IoMax>20</IoMax>
        <PaidType>1</PaidType>
        <Name>alikafka_post-cn-mp91gnw0p***</Name>
        <EndPoint>192.168.0.XX:9092,192.168.0.XX:9092,192.168.0.XX:9092</EndPoint>
        <Tags>
            <Key>test</Key>
            <Value>test</Value>
        </Tags>
        <UpgradeServiceDetailInfo>
            <Current2OpenSourceVersion>2.2.0</Current2OpenSourceVersion>
        </UpgradeServiceDetailInfo>
        <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</DomainEndpoint>
        <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</SslDomainEndpoint>
        <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</SaslDomainEndpoint>
    </InstanceList>
</GetInstanceListResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Code" : 200,
  "Message" : "operation success.",
  "RequestId" : "4B6D821D-7F67-4CAA-9E13-A5A997C35***",
  "Success" : true,
  "InstanceList" : [ {
    "VpcId" : "vpc-bp1ojac7bv448nifjl***",
    "SpecType" : "professional",
    "DeployType" : 5,
    "CreateTime" : 1577961819000,
    "DiskSize" : 3600,
    "DiskType" : 1,
    "SecurityGroup" : "sg-bp13wfx7kz9pkowc***",
    "SslEndPoint" : "192.0.2.XX:9093,198.51.100.XX:9093,203.0.113.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-bp1fvuw0ljd7vzmo3d***",
    "ExpiredTime" : 1893581018000,
    "TopicNumLimit" : 180,
    "ZoneId" : "zonei",
    "IoMax" : 20,
    "PaidType" : 1,
    "Name" : "alikafka_post-cn-mp91gnw0p***",
    "EndPoint" : "192.168.0.XX:9092,192.168.0.XX:9092,192.168.0.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"
  } ]
}

错误码

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