Query instance information in a specified region-ApsaraMQ for Kafka(Kafka)-阿里云帮助中心

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.

Authorization information

The following table describes the authorization information corresponding to this API operation. The authorization information can be used in the Action policy element to grant a Resource Access Management (RAM) user or a RAM role the permissions to call the API operation. Take note of the following items:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are highlighted.
- If the permissions cannot be granted at the resource level, All resources is used in the Resource type column of the operation.
Condition key: the condition key that is defined by the Alibaba Cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation

Access level

Resource type

Condition key

Associated operation

alikafka:ListInstance

get

All resources

None

None

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 order ID. You can obtain the order ID on the 订购订单 page in the Expenses and Costs console. Important You cannot query serverless instances by order ID.	6072673****
InstanceId	array	No	The instance IDs.
	string	No	The instance ID.	alikafka_post-cn-mp91gnw0****
Tag	array<object>	No	The tags.
	object	No
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. The tag key 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. The tag value cannot start with aliyun or acs: and cannot contain `http://` or `https://`.	test
ResourceGroupId	string	No	The ID of the resource group. You can query the ID on the Resource Group page in the Resource Management console.	rg-ac***********7q
Series	string	No	The instance version. You can use instance versions to filter different versions of instances. Valid values: v2 v3 confluent	v3

Response parameters

Parameter	Type	Description	Example
	object
Code	integer	The response code. The value 200 indicates that the request was successful.	200
Message	string	The response message.	operation success.
RequestId	string	The request ID.	4B6D821D-7F67-4CAA-9E13-A5A997C3****
Success	boolean	Indicates whether the request was successful.	true
InstanceList	array<object>	The instances.
	object
VpcId	string	The ID of the virtual private cloud (VPC) in which the instance is deployed.	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 of the instance. Unit: GB.	3600
DiskType	integer	The disk type of the instance. Valid values: 0: ultra disk 1: standard SSD	1
SecurityGroup	string	The security group of the instance. If the instance is deployed in the ApsaraMQ for Kafka console or by 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 return 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	Note This parameter is out of date. We recommend that you refer to ViewInstanceStatusCode. 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 change 10: released 11: changing 15: expired 30: scaling	5
EipMax	integer	The maximum Internet traffic in the instance.	20
RegionId	string	The ID of the region where the instance resides.	cn-hangzhou
MsgRetain	integer	The period for which messages in the instance are retained. Unit: hours.	72
VSwitchId	string	The ID of the vSwitch to which the instance belongs.	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
IoMaxRead	integer	The maximum read traffic in the instance. Unit: Mbit/s.	1000
IoMaxWrite	integer	The maximum write traffic. Unit: Mbit/s.	1000
IoMax	integer	The maximum traffic in the instance.	20
PaidType	integer	The billing method. Valid values: 0: the subscription billing method 1: the pay-as-you-go billing method 3: the pay-as-you-go billing method for serverless ApsaraMQ for Kafka instances 4: the subscription billing method for ApsaraMQ for Confluent instances	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	array<object>	The tags.
	object
Key	string	The tag key.	test
Value	string	The tag value.	test
UpgradeServiceDetailInfo	object	The upgrade information about 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 ID of the resource group.	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 used for cloud disk encryption in the region where the instance resides.	0d24xxxx-da7b-4786-b981-9a164dxxxxxx
StandardZoneId	string	The zone ID.	cn-hangzhou-k
IoMaxSpec	string	The traffic specification.	alikafka.hw.2xlarge
ReservedPublishCapacity	integer	The traffic reserved for message publishing. Unit: MB/s. Note This parameter is returned only if the instance is a serverless ApsaraMQ for Kafka instance.	60
ReservedSubscribeCapacity	integer	The traffic reserved for message subscription. Unit: MB/s. Note This parameter is returned only if the instance is a serverless ApsaraMQ for Kafka instance.	60
ViewInstanceStatusCode	integer	The instance status. The valid values are consistent with the values displayed in the ApsaraMQ for Kafka console. This parameter is used in the new version of ApsaraMQ for Kafka. Valid values: 0: pending 1: deploying 2: running 3: stopped 4: expiring 5: expired 6: released 7: upgrading 8: migrating 21: stopping 22: starting 23: releasing 30: auto scaling 101: deployment failed 102: upgrade failed 103: migration failed	2
ConfluentConfig	object	The parameters that are returned for the ApsaraMQ for Confluent instance.
KafkaCU	integer	The number of CPU cores of the Kafka broker.	4
KafkaStorage	integer	The disk capacity of the Kafka broker. Unit: GB	800
KafkaReplica	integer	The number of replicas of the Kafka broker.	3
ZooKeeperCU	integer	The number of CPU cores of ZooKeeper.	2
ZooKeeperStorage	integer	The disk capacity of ZooKeeper. Unit: GB	100
ZooKeeperReplica	integer	The number of replicas of ZooKeeper.	3
ControlCenterCU	integer	The number of CPU cores of Control Center.	4
ControlCenterStorage	integer	The disk capacity of Control Center. Unit: GB	300
ControlCenterReplica	integer	The number of replicas of Control Center.	1
SchemaRegistryCU	integer	The number of CPU cores of Schema Registry.	4
SchemaRegistryReplica	integer	The number of replicas of Schema Registry.	2
ConnectCU	integer	The number of CPU cores of Connect.	4
ConnectReplica	integer	The number of replicas of Connect.	2
KsqlCU	integer	The number of CPU cores of KsqlDB.	2
KsqlStorage	integer	The disk capacity of ksqlDB. Unit: GB	100
KsqlReplica	integer	The number of replicas of ksqlDB.	2
KafkaRestProxyCU	integer	The number of CPU cores of Kafka Rest Proxy.	4
KafkaRestProxyReplica	integer	The number of replicas of Kafka Rest Proxy.	2
Series	string	The instance version. Valid values: v2, v3, and confluent.	v3

Description of AllConfig

Parameter	Type	Valid value	Example	Description
enable.vpc_sasl_ssl	Boolean	- true - false	false	Indicates whether VPC transmission encryption is enabled. If you enable VPC transmission encryption, you must also enable access control list (ACL).
kafka.log.retention.hours	Integer	24 to 480	66	The period of time for which messages are retained. Unit: hours.
enable.acl	Boolean	- true - false	false	Indicates whether ACL is enabled. You can enable ACL only for ApsaraMQ for Kafka Professional Edition instances and serverless ApsaraMQ for Kafka instances whose versions are 2.2.0 or later.
kafka.message.max.bytes	Integer	1048576 to 10485760	6291456	The maximum size of a message. Unit: bytes.

Examples

Sample success responses

JSON format

{
  "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",
        "IoMaxRead": 1000,
        "IoMaxWrite": 1000,
        "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",
        "ReservedPublishCapacity": 60,
        "ReservedSubscribeCapacity": 60,
        "ViewInstanceStatusCode": 2,
        "ConfluentConfig": {
          "KafkaCU": 4,
          "KafkaStorage": 800,
          "KafkaReplica": 3,
          "ZooKeeperCU": 2,
          "ZooKeeperStorage": 100,
          "ZooKeeperReplica": 3,
          "ControlCenterCU": 4,
          "ControlCenterStorage": 300,
          "ControlCenterReplica": 1,
          "SchemaRegistryCU": 4,
          "SchemaRegistryReplica": 2,
          "ConnectCU": 4,
          "ConnectReplica": 2,
          "KsqlCU": 2,
          "KsqlStorage": 100,
          "KsqlReplica": 2,
          "KafkaRestProxyCU": 4,
          "KafkaRestProxyReplica": 2
        },
        "Series": "v3"
      }
    ]
  }
}

Error codes

For information about error codes, see Common error codes.

Change history

Effective date	Content	Operation
2024-08-16	The description of the API operation is modified.	查看变更详情
2024-04-23	The input parameters and response structure of the API operation are modified.	查看变更详情
2024-04-11	The response structure of the API operation is modified.	查看变更详情
2024-03-25	The response structure of the API operation is modified.	查看变更详情
2024-03-13	The response structure of the API operation is modified.	查看变更详情
2024-02-27	The response structure of the API operation is modified.	查看变更详情
2022-08-03	The response structure of the API operation is modified.	查看变更详情
2022-08-02	The response structure of the API operation is modified.	查看变更详情
2021-12-20	The response structure of the API operation is modified.	查看变更详情