GetInstanceList - ApsaraMQ for Kafka - Alibaba Cloud Documentation Center

Queries the information about 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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the instance resides.	cn-hangzhou
OrderId	string	No	The ID of the order. You can obtain the order ID on the Orders page in Alibaba Cloud User Center.	6072673****
InstanceId	array	No	The IDs of instances.
	string	No	The ID of the instance.	alikafka_post-cn-mp91gnw0****
Tag	object []	No	The tags.
Key	string	No	The tag key. If you leave this parameter empty, the keys of all tags are matched. The tag key can be up to 128 characters in length. It cannot start with aliyun or acs: and cannot contain `http://` or `https://`.	test
Value	string	No	The tag value. If you leave Key empty, you must also leave this parameter empty. If you leave this parameter empty, the values of all tags are matched. The tag value can be up to 128 characters in length. It cannot start with aliyun or acs: and cannot contain `http://` or `https://`.	test
ResourceGroupId	string	No	The ID of the resource group. You can obtain this ID on the Resource Group page in the Resource Management console.	rg-ac***********7q

Response parameters

Parameter	Type	Description	Example
	object
Code	integer	The HTTP status code returned. The HTTP status code 200 indicates that the call is successful.	200
Message	string	The message returned.	operation success.
RequestId	string	The ID of the region.	4B6D821D-7F67-4CAA-9E13-A5A997C3****
Success	boolean	Indicates whether the call was successful.	true
InstanceList	object []	The instances.
VpcId	string	The virtual private cloud (VPC) ID.	vpc-bp1ojac7bv448nifj****
SpecType	string	The instance edition. Valid values: professional: Professional Edition (High Write) professionalForHighRead: Professional Edition (High Read) normal: Standard Edition	professional
DeployType	integer	The type of the network in which the instance is deployed. Valid values: 4: Internet and VPC 5: VPC	5
CreateTime	long	The time when the instance was created. Unit: milliseconds.	1577961819000
DiskSize	integer	The disk size. Unit: GB.	3600
DiskType	integer	The disk type. Valid values: 0: ultra disk 1: standard SSD	1
SecurityGroup	string	The security group of the instance. If the instance is deployed by using the ApsaraMQ for Kafka console or calling the StartInstance operation without a security group configured, no value is returned. If the instance is deployed by calling the StartInstance operation with a security group configured, the returned value is the configured security group.	sg-bp13wfx7kz9pkow****
SslEndPoint	string	The Secure Sockets Layer (SSL) endpoint of the instance in IP address mode. ApsaraMQ for Kafka instances support endpoints in domain name mode and IP address mode. Endpoints in domain name mode: An endpoint in this mode consists of the domain name of the instance and a port number. The format of an endpoint in this mode is `{Instance domain name}:{Port number}`. Endpoints in IP address mode: An endpoint in this mode consists of the IP address of the broker and a port number. The format of an endpoint in this mode is `{Broker IP address}:{Port number}`.	192.0.XX.XX:9093,198.51.XX.XX:9093,203.0.XX.XX:9093
InstanceId	string	The instance ID.	alikafka_pre-cn-mp919o4v****
AllConfig	string	The configurations of the deployed ApsaraMQ for Kafka instance.	{\"enable.vpc_sasl_ssl\":\"false\",\"kafka.log.retention.hours\":\"66\",\"enable.acl\":\"false\",\"kafka.message.max.bytes\":\"6291456\"}
ServiceStatus	integer	The instance status. Valid values: 0: pending 1: preparing hardware resources 2: initializing 3: starting 5: running 6: migrating 7: ready for upgrade 8: upgrading 9: ready for changes 10: released 11: changing 15: expired	5
EipMax	integer	The peak Internet traffic allowed for the instance.	20
RegionId	string	The ID of the region where the instance resides.	cn-hangzhou
MsgRetain	integer	The retention period of messages in the instance. Unit: hours.	72
VSwitchId	string	The vSwitch ID of the instance.	vsw-bp1fvuw0ljd7vzmo3****
ExpiredTime	long	The time when the instance expires. Unit: milliseconds.	1893581018000
TopicNumLimit	integer	The maximum number of topics on the instance.	180
ZoneId	string	The zone ID.	zonei
IoMax	integer	The peak traffic allowed for the instance.	20
PaidType	integer	The billing method of the instance. Valid values: 0: subscription 1: pay-as-you-go	1
Name	string	The instance name.	alikafka_post-cn-mp91gnw0****
EndPoint	string	The default endpoint of the instance in IP address mode. ApsaraMQ for Kafka instances support endpoints in domain name mode and IP address mode. Endpoints in domain name mode: An endpoint in this mode consists of the domain name of the instance and a port number. The format of an endpoint in this mode is `{Instance domain name}:{Port number}`. Endpoints in IP address mode: An endpoint in this mode consists of the IP address of the broker and a port number. The format of an endpoint in this mode is `{Broker IP address}:{Port number}`.	192.168.XX.XX:9092,192.168.XX.XX:9092,192.168.XX.XX:9092
Tags	object []	The tags.
Key	string	The tag key.	test
Value	string	The tag value.	test
UpgradeServiceDetailInfo	object	The upgrade information of the instance.
Current2OpenSourceVersion	string	The open source Apache Kafka version that corresponds to the instance.	2.2.0
DomainEndpoint	string	The default endpoint of the instance in domain name mode. ApsaraMQ for Kafka instances support endpoints in domain name mode and IP address mode. Endpoints in domain name mode: An endpoint in this mode consists of the domain name of the instance and a port number. The format of an endpoint in this mode is `{Instance domain name}:{Port number}`. Endpoints in IP address mode: An endpoint in this mode consists of the IP address of the broker and a port number. The format of an endpoint in this mode is `{Broker IP address}:{Port number}`.	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	The SSL endpoint of the instance in domain name mode. ApsaraMQ for Kafka instances support endpoints in domain name mode and IP address mode. Endpoints in domain name mode: An endpoint in this mode consists of the domain name of the instance and a port number. The format of an endpoint in this mode is `{Instance domain name}:{Port number}`. Endpoints in IP address mode: An endpoint in this mode consists of the IP address of the broker and a port number. The format of an endpoint in this mode is `{Broker IP address}:{Port number}`.	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	The Simple Authentication and Security Layer (SASL) endpoint of the instance in domain name mode. ApsaraMQ for Kafka instances support endpoints in domain name mode and IP address mode. Endpoints in domain name mode: An endpoint in this mode consists of the domain name of the instance and a port number. The format of an endpoint in this mode is `{Instance domain name}:{Port number}`. Endpoints in IP address mode: An endpoint in this mode consists of the IP address of the broker and a port number. The format of an endpoint in this mode is `{Broker IP address}:{Port number}`.	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	The resource group ID.	rg-ac***********7q
UsedTopicCount	integer	The number of used topics.	3
UsedGroupCount	integer	The number of used groups.	10
UsedPartitionCount	integer	The number of used partitions.	25
KmsKeyId	string	The ID of the key that is used for disk encryption in the region where the instance is deployed.	0d24xxxx-da7b-4786-b981-9a164dxxxxxx
StandardZoneId	string	The zone ID.	cn-hangzhou-k
IoMaxSpec	string	The traffic specification.	alikafka.hw.2xlarge

AllConfig parameters

Parameter	Type	Valid value	Example	Description
enable.vpc_sasl_ssl	Boolean	- true- false	false	Specifies whether to enable the virtual private cloud (VPC) transmission encryption feature. If the VPC transmission encryption feature 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	Specifies whether to enable the ACL feature.
kafka.message.max.bytes	Integer	1048576 to 10485760	6291456	The maximum size of a message. Unit: bytes.

Examples

Sample success responses

JSONformat

{
  "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": 0,
        "ReservedSubscribeCapacity": 0
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2024-03-13