Message Queue for Kafka
Message Queue for Kafka
Message Queue for Kafka
Document
What's new
Product Overview
Product Billing
Quick Start
User Guide
Instance management
Instance lifecycle management
Connection management
Instance operation
Topic management
Rate limiting management
Group management
User management
ACL management
Monitoring and alerts
Access control
Allowlist management
Cluster migration
Kafka Agent
API Reference
V2（2022-05-01）
How to call the API
Resource check
Instance management
Network management
Topic management
Group management
Query messages
SASL user management
ACL strategy management
Operation audit
Tag management
Allowlist management
Appendix
V1（2018-01-01）
How to call the API
Instance management
Topic management
Group management
SASL user management
Appendix
SDK Reference
Apache Kafka SDK
Java client SDK
Go client SDK
Python client SDK
C++ client SDK
Volcengine SDK
Volcengine Go SDK
Volcengine Python SDK
Volcengine Java SDK
Best Practices
Kafka service migration
Perform production and consumption stress tests on Kafka
- Documentation
Message Queue for KafkaAPI ReferenceV1（2018-01-01）Instance managementDescribeInstancesSummary
Copy page
Download PDFInstance management
DescribeInstancesSummary
Copy pageDownload PDFDescribeInstancesSummary
Call the DescribeInstancesSummary API to obtain the list of Instances under the current account.
Instructions
The instance list provides a paginated query interface and returns only an overview of Kafka instances. To obtain detailed information, please use the DescribeInstanceDetail API.
- The API Version of this interface is 2018-01-01.
- The call frequency limit for this interface is 100 times per second. If the frequency limit is exceeded, the error "AccountFlowLimitExceeded" will be returned.
Request parameters
Parameters | Parameter types | Required | Example value | DescriptionDescription |
PageNumber | Integer | Yes | 1 | The page number to query. The valid range is non-zero integers. |
PageSize | Integer | Yes | 10 | The page size to be queried. The valid range is 1 to 50. |
Filters | List | No | - | Filter fields used for instance queries. The currently supported filter fields are:
|
SortFiledName | String | No | Name | Sorting field for instance query results. Sort by Status by default. Can be set to:
|
SortOrder | String | No | Asc | The sorting method used for instance queries. The default is ascending order.
|
Response parameters
Parameters | Parameter types | DescriptionDescription |
Total | Integer | Number of instances. |
Instances | List |
Example
Request example
POST https://kafka.volcengineapi.com/?Action=DescribeInstancesSummary&Version=2018-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: kafka.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-beijing/kafka/request, SignedHeaders=x-date, Signature=********
{
"PageNumber": 1,
"PageSize": 1,
"Filters": [
{
"Name": "Name",
"Values": [
""
]
}
],
"SortFiledName": "",
"SortOrder": "Asc"
}
Response example
{
"ResponseMetadata": {
"RequestId": "****************",
"Action": "DescribeInstancesSummary",
"Version": "2018-01-01",
"Service": "kafka",
"Region": "cn-beijing"
},
"Result": {
"Instances": [
{
"AccountId": 2000006376,
"AvaliableZones": [
{
"ZoneId": "cn-beijing-a",
"ZoneIdInChinese": "North China 2 (Beijing) - Availability Zone A"
}
],
"CreateTime": "2022-01-18T14:28:36+08:00",
"Description": "",
"InstanceId": "kafka-******",
"InstanceName": "kafka",
"KafkaChargeInfo": {
"ChargeStatus": "Normal",
"ChargeSubType": "Monthly",
"ChargeType": "PostPaid",
"CreatedTime": 1642487317,
"OrderId": "******",
"OverdueTime": 0
},
"KafkaSpecification": "kafka.n3.x2.small",
"ProjectName": "",
"Status": "Running",
"UsedGroupNumber": 0,
"UsedTopicNumber": 2,
"VpcInfo": {
"ID": "vpc-******",
"Name": "mq-test",
"SubnetId": "******"
}
}
],
"Total": 3
}
Last updated: 2025.10.24 15:11:24
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
