Help Center/ Distributed Message Service for Kafka/ API Reference/ Getting Started
Updated on 2024-07-10 GMT+08:00
View PDF
Share

Getting Started

Scenarios

This section describes how to call an API to create a Kafka instance and customize the computing capabilities and storage space of the instance based on service requirements.

For details on how to call APIs, see Calling APIs.

Prerequisites

Creating a Kafka Instance

The following is an example request for creating a Kafka instance:

{
 "name": "kafka-demo",
 "engine": "kafka",
 "engine_version": 2.7,
 "broker_num": 3,
 "storage_space": 300,
 "vpc_id": "ead6c5ff-xxx-9ba91820e72c",
 "security_group_id": "aa75ae22-xxx-a9dec8c73220",
 "subnet_id": "3cb6afa2-xxx-05a7f671d6a8",
 "available_zones": [
  "effdcbcxxx6b42f56533"
 ],
 "product_id": "c6.2u4g.cluster",
 "storage_spec_code": "dms.physical.storage.high.v2"
}
  • name: name of the instance.
  • engine: message engine. The value is kafka.
  • engine_version: version of the message engine.
  • broker_num: number of proxies.
  • storage_space: message storage space in GB. For details about the value range, see Creating an Instance.
  • vpc_id: ID of the VPC where the Kafka instance resides. Obtain the value by using the API described in Creating an Instance.
  • security_group_id: ID of the security group. Obtain the value by using the API described in Creating an Instance.
  • subnet_id: ID of the VPC subnet. Obtain the value by using the API described in Creating an Instance.
  • available_zones: ID of the AZ where the instance resides. The value cannot be empty or null. Obtain the value by calling the API described in Querying AZ Information.
  • product_id: ID of the product. Obtain the value by calling the API described in Querying Product Specifications.
  • storage_spec_code: storage I/O specification. For details about the value range, see Creating an Instance.