Help Center/ Distributed Message Service for RocketMQ/ API Reference/ Getting Started
Updated on 2024-02-01 GMT+08:00
View PDF
Share

Getting Started

Scenarios

This section describes how to call an API to create a RocketMQ 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

The endpoints of IAM and RocketMQ have been obtained. For details, see Regions and Endpoints.

Creating a RocketMQ Instance

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

{
 "name": "rocketmq-test",
 "engine": "reliability",
 "engine_version": "4.8.0",
 "storage_space": 600,
 "vpc_id": "ead6cxxxxxx9ba91820e72c",
 "subnet_id": "3cb6axxxxxxa7f671d6a8",
 "security_group_id": "d39c8xxxxxxaa8510a498",
 "available_zones": [
  "effdcxxxxxx2f56533"
 ],
 "product_id": "c6.4u8g.cluster",
 "storage_spec_code": "dms.physical.storage.high.v2",
 "broker_num": 1
}
  • name: name of the instance.
  • engine: message engine. The value is reliability.
  • engine_version: version of the message engine.
  • storage_space: message storage space in MB. For details about the value range, see Creating an Instance.
  • vpc_id: ID of the Virtual Private Cloud (VPC) where the RocketMQ instance resides. You can query the VPC ID on the VPC console or by calling the API for querying VPCs.
  • subnet_id: ID of the VPC subnet. You can obtain the value on the VPC console or by calling the API for querying subnets.
  • security_group_id: ID of the security group. You can obtain the value on the VPC console or by calling the API for querying security groups.
  • 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. For details about the value range, see Creating an Instance.
  • storage_spec_code: storage I/O specification. For details about the value range, see Creating an Instance.
  • broker_num: number of brokers.