Help Center> Distributed Message Service for RabbitMQ> API Reference> Getting Started
View PDF

Getting Started

Scenarios

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

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

{
"name": "rabbitmq-demo",
"engine": "rabbitmq",
"engine_version": "3.7.17",
"storage_space": 100,
"access_user": "test",
"password": "Z******d",
"vpc_id": "1aa6aa54-c37c-4948-8547-efdabece35f1",
"security_group_id": "d8c81e0f-de6a-4110-8c96-81af3eacb3d1",
"subnet_id": "d3d1e7f3-939b-4920-a1e6-61ba9e6f5bfd",
"available_zones": [
"72d50cedc49846b9b42c21495f38d81c"
 ],
"product_id": "00300-30109-0--0",
"storage_spec_code": "dms.physical.storage.high"
}

  • name: name of the instance.
  • engine: message engine. The value is rabbitmq.
  • engine_version: version of the message engine. Currently, only version 3.7.17 is supported.
  • storage_space: message storage space in GB. For details about the value range, see section "Creating a Pay-per-Use Instance".
  • access_user: user-defined username for logging in to RabbitMQ.
  • password: user-defined password for logging in to RabbitMQ.
  • vpc_id: ID of the Virtual Private Cloud (VPC) where the instance resides. You can query the VPC ID on the VPC console or by calling the API for querying VPCs.
  • security_group_id: ID of the security group. You can query the security group ID on the VPC console or by calling the API for querying security groups.
  • subnet_id: ID of the VPC subnet. You can query the network ID on the VPC console or by calling the API for querying subnets.
  • available_zones: ID of the AZ where the instance resides. The value cannot be empty or null. For details, see section "Querying AZ Information".
  • product_id: ID of the product. For details, see section "Querying Product Specifications".
  • storage_spec_code: storage I/O specification. For details about the value range, see section "Creating a Pay-per-Use Instance".