Help Center/ Distributed Message Service for RocketMQ/ API Reference (ME-Abu Dhabi Region)/ Getting Started
Updated on 2023-05-06 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",
  "description" : "",
  "engine" : "reliability",
  "engine_version" : "4.8.0",
  "storage_space" : 600,
  "vpc_id" : "3db8490c-******-047b0de4c5cf",
  "subnet_id" : "0a0f1fcb-******-301867394d50",
  "security_group_id" : "23c5977f-******-08d8a0bc4e6c",
  "available_zones" : [ "9f1c58067******a9b18c77" ],
  "product_id" : "c6.4u8g.cluster",
  "ssl_enable" : false,
  "storage_spec_code" : "dms.physical.storage.ultra.v2",
  "ipv6_enable" : false,
  "enable_publicip" : false,
  "publicip_id" : ""
}
  • name: name of the instance.
  • description: description 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 a Pay-per-Use Instance.
  • vpc_id: ID of the Virtual Private Cloud (VPC) where the RocketMQ instance resides. Obtain the value by using the API described in Creating a Pay-per-Use Instance.
  • subnet_id: ID of the VPC subnet. Obtain the value by using the API described in Creating a Pay-per-Use Instance.
  • security_group_id: ID of the security group. Obtain the value by using the API described in Creating a Pay-per-Use 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. For details about the value range, see Creating a Pay-per-Use Instance.
  • ssl_enable: Indicates whether to enable SSL-encrypted access.
  • storage_spec_code: storage I/O specification. For details about the value range, see Creating a Pay-per-Use Instance.
  • ipv6_enable: Indicates whether to support IPv6.
  • enable_publicip: Indicates whether to enable public access.
  • publicip_id: ID of the elastic IP address (EIP) bound to the instance.