Queries Message Queue for Apache Kafka instances in a specified region.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes GetInstanceList

The operation that you want to perform. Set the value to GetInstanceList.

RegionId String Yes cn-hangzhou

The ID of the region in which the instance resides.

OrderId String No 20816072673****

The ID of the order. You can obtain an order ID on the orders page in Alibaba Cloud User Center.

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

The ID of the instance N.

Tag.N.Key String No test

The key of the resource tag N.

  • Valid values of N: 1 to 20.
  • If this parameter is left empty, the keys of all tags are matched.
  • The tag key can be up to 128 characters in length and cannot start with aliyun or acs:. The tag key cannot contain http:// or https://.
Tag.N.Value String No test

The value of the resource tag N.

  • Valid values of N: 1 to 20.
  • This parameter must be left empty if the Tag.N.Key parameter is left empty. If this parameter is left empty, the values of all tags are matched.
  • The tag value can be up to 128 characters in length and cannot start with aliyun or acs:. The tag value cannot contain http:// or https://.

Response parameters

Parameter Type Example Description
Code Integer 200

The HTTP status code returned. The HTTP status code 200 indicates that the request is successful.

Message String operation success.

The message returned.

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

The ID of the request.

Success Boolean true

Indicates whether the request is successful.

InstanceList Array of InstanceVO

The details of instances.

InstanceVO
VpcId String vpc-bp1ojac7bv448nifjl***

The ID of the virtual private cloud (VPC).

SpecType String professional

The edition of the instance. Valid values:

  • professional: Professional Edition (High Write)
  • professionalForHighRead: Professional Edition (High Read)
  • normal: Standard Edition
DeployType Integer 5

The deployment mode of the instance. Valid values:

  • 4: allows access from the Internet and a VPC.
  • 5: allows access only from a VPC.
CreateTime Long 1577961819000

The time when the instance was created.

DiskSize Integer 3600

The disk capacity of the instance.

DiskType Integer 1

The disk type of the instance. Valid values:

  • 0: ultra disk
  • 1: SSD
SecurityGroup String sg-bp13wfx7kz9pkowc***

The security group of the instance.

  • If you deploy the instance in the Message Queue for Apache Kafka console or by calling the StartInstance operation without no security group configured, no value is returned for this parameter.
  • If you deploy the instance by calling the StartInstance operation with a security group configured, the configured security group is returned for this parameter.
SslEndPoint String 192.0.2.XX:9093,198.51.100.XX:9093,203.0.113.XX:9093

The SSL endpoints of the instance in IP address mode. The SSL endpoints of an instance can be in domain name mode or IP address mode.

  • Domain name mode: An SSL endpoint in this mode consists of a domain name of the instance and a port number in the format of {Instance domain name}:{Port number}.
  • IP address mode: An SSL endpoint in this mode consists of the IP address of a broker and a port number in the format of {Broker IP address}:{Port number}.
InstanceId String alikafka_pre-cn-mp919o4v****

The ID of the instance.

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

The configurations of the instance.

ServiceStatus Integer 5

The status of the instance. Valid values:

  • 0: pending
  • 1: deploying
  • 5: running
  • 15: expired
EipMax Integer 20

The peak public traffic allowed for the instance.

RegionId String cn-hangzhou

The ID of the region in which the instance resides.

MsgRetain Integer 72

The retention period of messages on the instance.

VSwitchId String vsw-bp1fvuw0ljd7vzmo3d***

The ID of the vSwitch.

ExpiredTime Long 1893581018000

The time when the instance expires.

TopicNumLimit Integer 180

The maximum number of topics that can be created on the instance.

ZoneId String zonei

The ID of the zone.

IoMax Integer 20

The peak traffic allowed for the instance.

PaidType Integer 1

The billing method of the instance. Valid values:

  • 0: subscription
  • 1: pay-as-you-go
Name String alikafka_post-cn-mp91gnw0p***

The name of the instance.

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

The default endpoints of the instance in IP address mode. The default endpoints of an instance can be in domain name mode or IP address mode.

  • Domain name mode: A default endpoint in this mode consists of a domain name of the instance and a port number in the format of {Instance domain name}:{Port number}.
  • IP address mode: A default endpoint in this mode consists of the IP address of a broker and a port number in the format of {Broker IP address}:{Port number}.
Tags Array of TagVO

The tags bound to the instance.

TagVO
Key String test

The key of the tag.

Value String test

The value of the tag.

UpgradeServiceDetailInfo Object

The upgrade information of the instance.

Current2OpenSourceVersion String 2.2.0

The open source Apache Kafka version of the instance.

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

The default endpoints of the instance in domain name mode. The default endpoints of an instance can be in domain name mode or IP address mode.

  • Domain name mode: A default endpoint in this mode consists of a domain name of the instance and a port number in the format of {Instance domain name}:{Port number}.
  • IP address mode: A default endpoint in this mode consists of the IP address of a broker and a port number in the format of {Broker IP address}:{Port number}.
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

The SSL endpoints of the instance in domain name mode. The SSL endpoints of an instance can be in domain name mode or IP address mode.

  • Domain name mode: An SSL endpoint in this mode consists of a domain name of the instance and a port number in the format of {Instance domain name}:{Port number}.
  • IP address mode: An SSL endpoint in this mode consists of the IP address of a broker and a port number in the format of {Broker IP address}:{Port number}.
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

The Simple Authentication and Security Layer (SASL) endpoints of the instance in domain name mode. The SASL endpoints of an instance can be in domain name mode or IP address mode.

  • Domain name mode: An SASL endpoint in this mode consists of a domain name of the instance and a port number in the format of {Instance domain name}:{Port number}.
  • IP address mode: An SASL endpoint in this mode consists of the IP address of a broker and a port number in the format of {Broker IP address}:{Port number}.

AllConfig fields

Field

Type

Valid value

Example

Description

enable.vpc_sasl_ssl

Boolean
  • true
  • false

false

Indicates whether VPC transmission encryption is enabled. If VPC transmission encryption is enabled, you must also enable the access control list (ACL) feature.

kafka.log.retention.hours

Integer

24 to 480

66

The retention period of messages. Unit: hours.

enable.acl

Boolean
  • true
  • false

false

Indicates whether the ACL feature is enabled.

kafka.message.max.bytes

Integer

1048576 to 10485760

6291456

The maximum size of a message. Unit: bytes.

Examples

Sample requests

http(s)://alikafka.cn-hangzhou.aliyuncs.com/?Action=GetInstanceList
&RegionId=cn-hangzhou
&OrderId=20816072673****
&InstanceId=["alikafka_post-cn-mp91gnw0p***"]
&Tag=[{"Key":"test","Value":"test"}]
&<Common request parameters>

Sample success responses

XML format 

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 format 

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"
  } ]
}

Error codes

For a list of error codes, visit the API Error Center.