Docs
EN
Docs
Console
Sign in
Message Queue for Kafka
Document
Message Queue for Kafka
Message Queue for Kafka
Document
What's new
Release Notes for New Features
Product Overview
What is Message Queue for Kafka
Product features
Product functions
Product specifications
Related concepts
Region and availability zone
Limits
Product Billing
Billing overview
Billing item
Billing method
Pay-as-you-go
Subscriptions
Switch to subscription
Instance renewal
Description of arrears or expiration
Costs for unsubscribing or configuration change
Taxes and invoices
Quick Start
Overview
Prepare the environment
Create resource
Connect instance
Connect to instance by using PLAINTEXT endpoint
Connect to instance by using SASL_PLAINTEXT endpoint
Connect to the instance using SASL_SSL endpoint
Connect to the instance using the SSL endpoint
User Guide
Instance management
Instance lifecycle management
Create instance
View instance details
Upgrade instance specifications
Delete instance
Restart instance
Connection management
Add endpoint
View access points
Enable public network access
Set public network analysis
Delete access point
Instance operation
Modify parameter configuration
View broker information
Set disk cleanup threshold
Operation audit
Tag Management
Overview of instance tags
Bind tags
Filter instances by tag
Edit and unbind tags
Topic management
Create Topic
Import topics in bulk
Export Topic list
Modify Topic configuration
Manage topic tags
View topic details
Delete Topic
Online debugging
Rate limiting management
Add rate limiting
Modify rate limit
Delete rate limit
Group management
Create Group
Bulk import Groups
Export Group list
Manage Group tags
View Group details
Reset consumption offsets
Delete Group
Message query
User management
Create SASL user
Bulk import SASL users
Reset SASL user password
View PLAIN user password
Delete SASL user
ACL management
Create ACL
Delete ACL
Background task management
Monitoring and alerts
View monitoring data
Set alarm policy
Recommended alarm rules
Access control
Manage permissions based on IAM
Resources and actions for which the permissions can be granted
Cross-service access
Access strategy template
Allowlist management
Create allowlist
Associate instance with allowlist
Disassociate instance from allowlist
View allowlist information
Edit allowlist
Delete allowlist
Cluster migration
Cluster migration overview
Create migration task
Migrate metadata
Online metadata migration
Offline migration metadata
Import metadata
Edit migration data configuration
View migration command
Delete migration task
API Reference
API version description
V2(2022-05-01)
Usage note
API overview
How to call the API
Request structure
Service address
Signature method
Response
Common parameters
Instance management
CreateInstance - Create instance
DescribeInstances - View instances list
DescribeInstanceDetail - View instance details
DeleteInstance - Delete instance
ModifyInstanceAttributes - Modify instance basic information
ModifyInstanceSpec - Modify instance specification
ModifyInstanceParameters - Modify instance parameters
ModifyInstanceChargeType - Change billing method
Resource check
DescribeRegions - View Region list
DescribeAvailabilityZones - View the availability zone list
Network management
CreatePublicAddress - Enable public network access
DeletePublicAddress - Disable public network access
Topic management
CreateTopic - Create Topic
DeleteTopic - Delete Topic
ModifyTopicAttributes - Modify Topic description
ModifyTopicParameters - Modify Topic parameter configuration
ModifyTopicAccessPolicies - Modify user permissions of the Topic
DescribeTopics - View Topic list
DescribeTopicParameters - View Topic parameter configuration
DescribeTopicPartitions - View Topic partitions
DescribeTopicAccessPolicies - View the permission list of a Topic
Group management
CreateGroup - Create Group
ModifyGroup - Update consumer Group
DeleteGroup - Delete Group
DescribeGroups - View Group list
DescribeConsumedTopics - View Topics subscribed by Group
DescribeConsumedPartitions - View Group subscribed partitions
ResetConsumedOffsets - Reset consumed offsets
Query messages
QueryMessageByTimestamp - Query messages by timestamp
SASL user management
CreateUser - Create SASL user
DeleteUser - Delete SASL user
ModifyUserAuthority - Change default SASL user permissions
DescribeUsers - View SASL user list
ACL strategy management
CreateAcl - Create ACL policy
DescribeAcls - Query ACL policies
DeleteAcl - Delete ACL strategy
Tag management
AddTagsToResource - Add instance tags
RemoveTagsFromResource - Unbind instance tags
DescribeTagsByResource - Query instance tags
Allowlist management
CreateAllowList - Create allowlist
ModifyAllowList - Modify allowlist
DeleteAllowList - Delete allowlist
DescribeAllowLists - Query allowlist
DescribeAllowListDetail - Query allowlist details
AssociateAllowList - Associate allowlist
DisassociateAllowList - Disassociate allowlist
Appendix
Request idempotency
V1(2018-01-01)
Usage note
How to call the API
Request structure
Service address
Signature method
Response
Common parameters
API overview
Instance management
ListKafkaConf
CreateKafkaInstance
DeleteKafkaInstance
DescribeInstanceDetail
DescribeInstancesSummary
ModifyInstanceDescription
ModifyInstanceName
ModifyInstanceParams
ModifyChargeToPrepaid
ScaleKafkaInstance
EnableInternetAccess
DisableInternetAccess
Topic management
CreateTopic
DeleteTopic
DescribeTopics
DescribeTopicAuthorities
DescribeTopicPartitions
ModifyTopic
ModifyTopicAuthorities
QueryMessageByMessageId
Group management
DeleteGroup
DescribeConsumedPartitions
DescribeConsumedTopics
DescribeGroups
ResetConsumedOffsets
SASL user management
CreateSaslUser
DescribeSaslUsers
DeleteSaslUser
ModifySaslPassword
ModifyUserAuthority
Appendix
Data structure
Error code
SDK Reference
Overview
Apache Kafka SDK
Java client SDK
Overview
Preparations
PLAINTEXT endpoint sending and receiving messages
SASL_PLAINTEXT access point sends and receives messages using PLAIN mechanism
SASL_PLAINTEXT access point sends and receives messages using SCRAM mechanism
SASL_SSL access point sends and receives messages using PLAIN mechanism
SASL_SSL access point sending and receiving messages using SCRAM mechanism
Configuration file
Go client SDK
Overview
Preparations
PLAINTEXT endpoint sending and receiving messages
SASL_PLAINTEXT access point sends and receives messages using PLAIN mechanism
SASL_PLAINTEXT access point sends and receives messages using SCRAM mechanism
SASL_SSL access point (PLAIN mechanism) message production and consumption
SASL_SSL access point (SCRAM mechanism) message production and consumption
SDK configuration description
Python client SDK
Overview
Preparations
PLAINTEXT endpoint sending and receiving messages
SASL_PLAINTEXT access point sends and receives messages using PLAIN mechanism
SASL_PLAINTEXT access point SCRAM mechanism message transmission
SASL_SSL access point (PLAIN mechanism) message production and consumption
SASL_SSL access point (SCRAM mechanism) message production and consumption
SDK configuration description
C++ client SDK
Overview
Preparations
PLAINTEXT endpoint sending and receiving messages
SASL_PLAINTEXT access point sending and receiving messages using PLAIN mechanism
SASL_PLAINTEXT endpoint SCRAM mechanism message transmission
SASL_SSL access point (PLAIN mechanism) message production and consumption
SASL_SSL access point (SCRAM mechanism) message production and consumption
Volcengine SDK
Overview
Volcengine Go SDK
Overview of the Go SDK
Install the Go SDK
Quick start
Volcengine Python SDK
Overview of the Python SDK
Install the Python SDK
Quick start
Volcengine Java SDK
Java SDK overview
Install the Java SDK
Quick start
Best Practices
Kafka service migration
Migration overview
Kafka migration to the cloud (Solution 1)
Migrate Kafka to the cloud (option 2)
View migration progress and results
Topic usage recommendations
Kafka producer best practices
Kafka consumer best practices
Message ordering and reliability
Data balancing in Kafka clusters
Multiple availability zone deployment for Kafka instances
Analysis of Kafka CPU consumption scenarios
Integrate Filebeat
Consume Kafka version message queues using Function Service
Perform production and consumption stress tests on Kafka
Overview
Use the PLAINTEXT access point to perform stress testing
Use the SASL_PLAINTEXT endpoint for stress testing
Stress testing using SASL_SSL endpoints
Data compression algorithm recommendations
FAQ
Product inquiry
Instance management
Topic and Group management
Instance connection
Message production and consumption
Troubleshooting
Instance management
Group and Topic management
Monitoring
Client
Message query
Documentation
Message Queue for Kafka
API Reference
V1(2018-01-01)
SASL user management
ModifySaslPassword
Copy page
Download PDF
SASL user management
ModifySaslPassword
Copy page
Download PDF
ModifySaslPassword
Last updated: 2025.10.20 15:53:29