Creates a Message Queue for Apache RocketMQ instance.

Usage notes

An instance is a virtual machine (VM) that can be used to store information about the topics and groups of Message Queue for Apache RocketMQ. You can call this operation when you need to create service resources for the business that you want to release. Before you call this operation, take note of the following limits:

  • A maximum of eight Message Queue for Apache RocketMQ instances can be deployed in each region.
  • This operation can be called to create only a Standard Edition instance. You can use the Message Queue for Apache RocketMQ console to create a Standard Edition instance and an Enterprise Platinum Edition instance. For information about how to create a Message Queue for Apache RocketMQ instance, see Manage instances.

QPS limit

Each Alibaba Cloud account can call this operation up to 10 times per second. If the number of requests that you send each second to call this operation exceeds the queries per second (QPS) limit, throttling is triggered. This may interrupt your business. For more information, see QPS limits.

Authorization

By default, only Alibaba Cloud accounts can call this operation. A Resource Access Management (RAM) user can call this operation only after the RAM user is granted the required permission. The following table describes the permission that is required to call this operation. For more information, see Policies and examples.

API

Action

Resource

OnsInstanceCreate

mq:CreateInstance

acs:mq:*:*:*

Request parameters

Parameter Type Required Example Description
Action String Yes OnsInstanceCreate

The operation that you want to perform. Set the value to OnsInstanceCreate.

Remark String No Description

The description of the instance.

InstanceName String Yes Test

The name of the instance. Configure this parameter based on the following rules:

  • The name of the instance must be unique in the region where the instance is deployed.
  • The name must be 3 to 64 characters in length and can contain letters, digits, hyphens (-), underscores (_), and Chinese characters.

Response parameters

Parameter Type Example Description
RequestId String A07E3902-B92E-44A6-B6C5-6AA111111****

The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.

Data Object

The results that are returned.

InstanceId String MQ_INST_188077086902****_BXSuW61e

The ID of the instance that is created.

InstanceType Integer 1

The edition of the instance that is created. Valid value:

  • 1: Standard Edition

Examples

Sample requests

http(s)://ons.cn-hangzhou.aliyuncs.com/?Action=OnsInstanceCreate
&InstanceName=Test
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<OnsInstanceCreateResponse>
<Data>
    <InstanceId>MQ_INST_188077086902****_BXSuW61e</InstanceId>
    <InstanceType>1</InstanceType>
</Data>
<RequestId>A07E3902-B92E-44A6-B6C5-6AA111111****</RequestId>
</OnsInstanceCreateResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Data" : {
    "InstanceId" : "MQ_INST_188077086902****_BXSuW61e",
    "InstanceType" : 1
  },
  "RequestId" : "A07E3902-B92E-44A6-B6C5-6AA111111****"
}

Error codes

For a list of error codes, visit the API Error Center.

Create an instance by using the console

Besides calling the OnsInstanceCreate operation, you can use the Message Queue for Apache RocketMQ console to create an instance. For information about how to use the Message Queue for Apache RocketMQ console to create an instance, see Manage instances.