Updated on 2025-02-11 GMT+08:00

API Overview

Table 1 APIs for managing instances

API

Description

Managing Lifecycle

Includes:

  • Creating an Instance
  • Listing All Instances
  • Querying an Instance
  • Deleting an Instance
  • Modifying Instance Information
  • Batch Restarting or Deleting Instances
  • Obtaining Instance Configurations
  • Modifying Instance Configurations
  • Upgrading an Instance

Instance Management

Includes:

  • Resetting the Password
  • Resetting Kafka Manager Password
  • Restarting Kafka Manager
  • Configuring Automatic Topic Creation
  • Modifying the Private IP Address for Cross-VPC Access
  • Querying Kafka Cluster Metadata
  • Reassigning Replicas of a Topic for a Kafka Instance
  • Reassigning Replicas of a Topic for a Kafka Instance
  • Modifying Kafka Access Modes
  • Querying the Disk Usage Status of Topics
  • Initiating Partition Reassigning for a Kafka Instance
  • Disabling Kafka Manager
  • Deleting a User or Client Quota
  • Querying User or Client Quotas
  • Creating User or Client Quotas
  • Modifying User or Client Quotas

Smart Connect

Includes:

  • Enabling Smart Connect (Pay-per-Use Instance)
  • Disabling Smart Connect (Pay-per-Use Instance)
  • Creating a Smart Connect Task
  • Querying Smart Connect Tasks
  • Querying Smart Connect Task Details
  • Deleting a Smart Connect Task
  • Pausing a Smart Connect Task
  • Restarting a Smart Connect Task
  • Starting a Smart Connect Task or Restarting a Paused or Running Smart Connect Task

Specification Modification Management

Includes:

  • Increasing Instance Specifications
  • Querying Product Information for Instance Specification Modification

Topic Management

Includes:

  • Producing Messages to Kafka
  • Creating a Topic for a Kafka Instance
  • Listing Topics of a Kafka Instance
  • Modifying Topics of a Kafka Instance
  • Batch Deleting Topics of a Kafka Instance
  • Querying the Partition List of a Topic
  • Querying the Current Producer List of a Topic
  • Querying Topic Details

Managing Consumer Groups

Includes:

  • Querying Consumer Group Details
  • Querying All Consumer Groups
  • Deleting Consumer Groups of a Kafka Instance in Batches
  • Creating a Consumer Group
  • Resetting Consumer Group Offset to the Specified Position
  • Querying the Offset of a Consumer Group
  • Modifying All Consumer Groups
  • Querying a Specified Consumer Group
  • Deleting a Specified Consumer Group
  • Modifying a Specified Consumer Group
  • Querying Topics of a Specified Consumer Group
  • Querying Consumers in a Specified Consumer Group

User Management

Includes:

  • Querying the User List
  • Creating a User
  • Deleting Users in Batches
  • Resetting a User Password
  • Modifying User Parameters
  • Querying User Permissions
  • Granting User Permissions

Managing Messages

Includes:

  • Querying messages
  • Querying a Message with a Specified Offset
  • Querying a Message with a Specified Time Period
  • Querying Offset of the Earliest Message in a Partition
  • Querying Offset of the Latest Message in a Partition
  • Deleting a Kafka Message

Background Task Management

Includes:

  • Listing Background Tasks
  • Querying a Background Task
  • Deleting a Background Task

Tag Management

Includes:

  • Batch Adding or Deleting Tags
  • Listing Tags of an Instance
  • Listing Tags of a Project

Diagnosis Management

Includes:

  • Pre-check Before Diagnosing Message Stack
  • Creating a Message Stack Diagnosis Task
  • Querying the Message Stack Diagnosis Report List
  • Batch Deleting Message Stack Diagnosis Reports
  • Querying Diagnosis Report Details

Other APIs

Includes:

  • Listing Maintenance Time Windows
  • Listing AZ Information
  • Querying Product Specifications List
  • Querying Kafka Instance Monitoring Dimensions
  • Querying vCPUs of a Kafka Flavor