Creates an ApsaraMQ for RabbitMQ instance.
Operation description
**Before you call this operation, make sure that you fully understand the billing methods and pricing of ApsaraMQ for RabbitMQ.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| amqp:CreateInstance | create | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ClientToken | string | No | The client token. | c2c5d1274axxxxxxxx |
| PaymentType | string | Yes | The billing method. Valid value:
Note
API operations provided by ApsaraMQ for RabbitMQ are supported only by subscription instances. You can set this parameter only to Subscription.
Enumeration Value:
| Subscription |
| Period | integer | No | The subscription period. The unit of the subscription period is specified by periodCycle. Note
This parameter takes effect only if you set PaymentType to Subscription. Default value: 1.
| 1 |
| PeriodCycle | string | No | The unit of the subscription period. Valid values:
Note
This parameter takes effect only if you set PaymentType to Subscription. Default value: Month.
| Month |
| AutoRenew | boolean | No | Specifies whether to enable auto-renewal. Valid values:
| AutoRenewal |
| AutoRenewPeriod | integer | No | The auto-renewal duration. Unit: months. Note
This parameter takes effect only if you set AutoRenew to true. Default value: 1.
| 1 |
| RenewStatus | string | No | The renewal status. This parameter is the same as AutoRenew. You can configure one of these parameters. Valid value:
Note
If you configure both this parameter and AutoRenew, the value of this parameter is used.
| false |
| RenewalDurationUnit | string | No | The unit of the auto-renewal period. Valid values:
| Month |
| InstanceType | string | No | The instance edition. Valid values:
| professional |
| ServerlessChargeType | string | No | The billing method of the pay-as-you-go instance. Valid values:
| onDemand |
| InstanceName | string | No | The instance name. We recommend that you specify a name that does not exceed 64 characters in length. | amqp-xxxxx |
| MaxPrivateTps | long | No | The maximum number of virtual private cloud (VPC)-based transactions per second (TPS) on the instance. Configure this parameter based on the values provided on the ApsaraMQ for RocketMQ buy page. | 1000 |
| SupportEip | boolean | No | Specifies whether elastic IP addresses (EIPs) are supported. Valid values:
| true |
| MaxEipTps | long | No | The maximum number of EIP-based TPS on the instance. Configure this parameter based on the values provided on the ApsaraMQ for RocketMQ buy page. | 128 |
| QueueCapacity | integer | No | The number of queues. Valid values:
| 1000 |
| MaxConnections | integer | No | The maximum number of connections that can be established to the instance. Configure this parameter based on the values provided on the ApsaraMQ for RocketMQ buy page. | 50000 |
| StorageSize | integer | No | The storage capacity. Unit: GB. Valid values:
Note
The value 0 specifies that storage space is available for Professional Edition and Enterprise Edition instances, but no storage fees are generated.
| 7 |
| SupportTracing | boolean | No | Specifies whether to enable the message trace feature. Valid values:
Note
| true |
| TracingStorageTime | integer | No | The retention period of messages. Unit: days. Valid values:
Note
This parameter takes effect only if you set SupportTracing to true.
| 3 |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "CCBB1225-C392-480E-8C7F-D09AB2CD2***",
"Code": 200,
"Message": "xxx failed,xxxx",
"Data": "amqp-cn-xxxxx",
"Success": true
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | INSUFFICIENT_AVAILABLE_QUOTA | Your account available limit is less than 0, please recharge before trying to purchase. | Your account available limit is less than 0, please recharge before trying to purchase. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-07-30 | The Error code has changed | View Change Details |
| 2024-03-06 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2024-03-05 | The request parameters of the API has changed | View Change Details |
| 2024-02-27 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2024-02-22 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2024-01-24 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2024-01-24 | The request parameters of the API has changed | View Change Details |