Queries the information about instances in a specified region.
Debugging
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.
| test |
Value | string | No | The tag value.
| 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
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
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",
"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 | The response structure of the API has changed | see changesets | ||
| ||||
2024-02-27 | The response structure of the API has changed | see changesets | ||
| ||||
2022-08-03 | The response structure of the API has changed | see changesets | ||
| ||||
2022-08-02 | The response structure of the API has changed | see changesets | ||
| ||||
2021-12-20 | The response structure of the API has changed | see changesets | ||
|