An instance is an independent Message Queue for RabbitMQ resource entity that includes basic resources such as virtual hosts (vhosts), exchanges, and queues. This topic describes how to create an instance, view instance details, upgrade an instance, downgrade an instance, and renew an instance in the Message Queue for RabbitMQ console.

Statuses

The status of a Message Queue for RabbitMQ instance varies based on the billing method of the instance and the instance edition.

Table 1. Statuses
State Description
Deploying
  • An instance in this state is unavailable.
  • This state is supported only for instances of the Enterprise Platinum Edition. An instance of the Enterprise Platinum Edition must be deployed by technical support after the instance is purchased.
Running
  • An instance in this state is available.
  • After you purchase an instance of the Professional Edition or Enterprise Edition, the instance enters the Running state.
Stopped
  • An instance in this state is unavailable.
  • The resources and data of an instance that is in the Stopped state are retained and can be restored.
Released
  • An instance in this state is unavailable.
  • The resources of an instance in the Released state are released and the data of the instance is deleted. The resources and data cannot be restored.
Warning You cannot manually release an instance. After an instance expires, the instance is automatically released. You can delete the record of the expired instance in the Message Queue for RabbitMQ console. After the record of the instance is deleted, the instance becomes unavailable and the resources of the instance are released and the data of the instance is deleted. The resources and data cannot be restored.

Supported operations

Operation Description
Create an instance Message Queue for RabbitMQ provides the following editions: Professional Edition, Enterprise Edition, and Enterprise Platinum Edition. The availability and features of and limits on the editions are different. For more information, see Instance editions.
  • Professional Edition: shared instances in which tenants are logically isolated and data is persistent. Each instance has three replicas to ensure high availability.
  • Enterprise Edition: shared instances in which tenants are logically isolated and data is persistent. Each instance has three replicas to ensure high availability.
  • Platinum Edition: dedicated instances in which data is persistent. Each instance has three replicas to ensure high availability. A dedicated instance is deployed in a dedicated physical cluster.
Note Message Queue for RabbitMQ no longer allow you to create Standard Edition instances. You can continue to use the existing instances of the Standard Edition.
View the details of an instance You can view the basic information and endpoints of and limits on an instance, and query messages and the peak transactions per second (TPS) of the instance in the Message Queue for RabbitMQ console.
Note You can view the TPS statistics of an instance only when the message tracing feature is enabled for the instance.
Upgrade the configurations of an instance When workloads on your business increase, you can increase the maximum TPS and the maximum number of queues for your instance. This helps prevent your business from being interrupted due to insufficient resources.
You can change the values of the following parameters to upgrade an instance:
  • Instance Type: This parameter is displayed only if the instance is of the Professional Edition or Enterprise Edition.
    Note You can upgrade an instance of the Professional Edition and Enterprise Edition to an instance of the Enterprise Platinum Edition.
  • Support Internet Access
  • Internet TPS
  • Peak TPS
  • Queues
    Important After you upgrade an instance of the Professional Edition or Enterprise Edition, the threshold values for the instance vary based on the value of the Queues parameter. If you increase the value of the Queues parameter, the threshold values of the instance are increased. For more information, see Limits on clusters.
  • Message Trace Support
  • Maximum Number of Connections: You can decrease the value of this parameter only if the instance is of the Enterprise Edition or Enterprise Platinum Edition.
  • Message Storage Space: You can increase the value of this parameter only if the instance is of the Enterprise Platinum Edition.
Downgrade the configurations of an instance When your business loads decrease, you can decrease the maximum TPS and the maximum number of queues for your instance. This helps improve resource utilization and reduce costs.
You can change the values of the following parameters to downgrade an instance:
  • Support Internet Access
  • Internet TPS
  • Peak TPS
  • Queues
    Important After you downgrade an instance of the Professional Edition or Enterprise Edition, the threshold values for the instance vary based on the value of the Queues parameter. If you decrease the value of the Queues parameter, the threshold values of the instance are decreased. For more information, see Limits on clusters.
  • Message Trace Support
  • Maximum Number of Connections: You can decrease the value of this parameter only if the instance is of the Enterprise Edition or Enterprise Platinum Edition.
  • Message Storage Space: You can decrease the value of this parameter only if the instance is of the Platinum Edition.
Renew an instance If an instance is released due to overdue payments, the service becomes unavailable and your business is interrupted. To prevent this issue, you must renew the instance at your earliest opportunity.
Note
  • You can renew only subscription instances that are in the Expired state or the Running state.
  • Message Queue for RabbitMQ allows you to create only subscription instances. The renewal operation does not apply to pay-as-you-go instances. For existing pay-as-you-go instances, you only need to keep the account balance sufficient.
  • For information about instance expiration, see Overview.

Create an instance

  1. Log on to the Message Queue for RabbitMQ console. In the left-side navigation pane, select Instances.
  2. In the top navigation bar, select a region. On the Instances page, click Create Instance.
  3. Purchase an instance by using one of the following methods:
      1. In the buy panel, specify a subscription duration, configure other required parameters, read the terms of service, select Message Queue for RabbitMQ Subscription Terms of Service, and then click Buy Now.
      2. In the panel that appears, confirm the information about the order and click Purchase.
      1. Click Go to Buy Page. On the Message Queue for RabbitMQ Subscription page, specify a subscription duration, configure other required parameters, and then click Buy Now.
      2. On the Confirm Order page, read the terms of service, select I have read and agree to Message Queue for RabbitMQ Subscription Agreement of Service, and then click Pay.
      3. On the page that appears, click Subscribe.
    In the top navigation bar, select the region where the instance is deployed. On the Instances page, the instance that is created is displayed.
    Note
    • After you purchase an instance of the Professional Edition or Enterprise Edition, the instance enters the Running state.
    • After you purchase an instance of the Enterprise Platinum Edition, the instance enters the Deploying state. After the instance is deployed, the instance enters the Running state.

View the details of an instance

  1. In the top navigation bar of the Instances page, select a region. In the instance list, click the name of the instance that you want to manage.
  2. On the Instance Details page, view the details of the instance.
    pg_instance_detail
    Table 2. Instance details
    Section Parameter Description
    Overview vhosts The maximum number of vhosts that can be created in the instance.
    Maximum Queues The maximum number of queues that can be created in the instance. For information about how to change the value of this parameter, see Upgrade instance configurations.
    Maximum TPS The maximum TPS of the instance. For information about how to change the value of this parameter, see Upgrade instance configurations.
    Basic Information Instance Name The name of the instance. You can manually change the instance name.
    Instance ID The ID of the instance. You cannot change the instance ID.
    Instance Edition The edition of the instance. Valid values: Professional Edition, Enterprise Edition, and Enterprise Platinum Edition. For more information, see Instance editions.
    Status The status of the instance. For more information, see Statuses.
    Billing Method The billing method of the instance. For more information, see Overview.

    On the Renewal page, you can renew the instance or enable the auto-renewal feature for the instance before the instance expires.

    Created At The point in time when the instance is created. The value is accurate to seconds.
    Expired At The point in time when the instance expires. The value is accurate to seconds.
    Support Internet Access Indicates whether the instance can be accessed over the Internet. For information about how to change the value of this parameter, see Upgrade instance configurations.
    Protocol Version The version of Advanced Message Queuing Protocol (AMQP). The version is 0-9-1.
    Endpoint Information VPC Endpoint The private endpoint of the instance.
    Public Endpoint The public endpoint of the instance. An instance can be accessed by using a public endpoint only if you enable the Internet Access feature for the instance when you create the instance.
    Limits Connections per Instance The maximum number of connections that can be established for the instance.
    vhosts per Instance The maximum number of vhosts that can be created in the instance.
    Exchanges per vhost The maximum number of exchanges that can be created for each vhost.
    Bindings per vhost The maximum number of bindings that can be created for each vhost.
    Consumers per Queue The maximum number of consumers that can be pulled to consume messages in a queue.
    Channels per Connection The maximum number of channels that can be created for each connection.
    Message Size The maximum number of bytes that a message in a queue can contain.
    Maximum Retention Period of Delayed Messages The maximum period of time for which a delayed message can be retained in a queue.
    Maximum Number of Times Messages Are Requeued The maximum number of times that a message can be requeued.
    Message Query Queue The name of the queue from which you want to query messages. For more information, see Query Messages.
    Message ID The ID of the message that you want to query. If you specify Query by Message ID as the value of the Query Method parameter, this parameter is required.

    For more information, see Query Messages.

    Time Range The time range during which you want to query messages. For more information, see Query Messages.
    Peak TPS Query Start Time The beginning of time range to query the maximum TPS.
    API The request method. If you select Query by API, this parameter is required.

    For more information, see Overview.

    Instance Seconds-level TPS Curve The curve chart that shows the TPS change trend by instance or API operation. The displayed TPS data is collected from a specified start time.
    Note The length of the time range in which the displayed TPS values are collected is equal to the retention period of the message trace. If the message trace is retained for more than 10 minutes, only data that is collected in the first 10 minutes is displayed in the chart.

Upgrade the configurations of an instance

Important
  • You can upgrade only the configurations of subscription instances that are in the Running state.
  • You can upgrade only the configurations of subscription instances. You cannot upgrade the configurations of pay-as-you-go instances or instances of the Standard Edition.
  1. In the top navigation bar of the Instances page, select a region. In the instance list, click the name of the instance that you want to manage.
  2. On the Instance Details page, click Upgrade Configuration in the upper-right corner of the Overview section.
  3. Upgrade the configurations of the instance by using one of the following methods:
      1. In the configuration panel, configure the required parameters to upgrade the instance configurations, read the terms of service, select Message Queue for RabbitMQ Subscription Agreement of Service, and then click Buy Now.
      2. In the panel that appears, confirm the information about the order and click Purchase.
      1. Click Go to Buy Page. On the Message Queue for RabbitMQ Subscription | Upgrade/Downgrade page, configure the Support Internet Access, Peak TPS, and Queues parameters, read the terms of service, select Message Queue for RabbitMQ Subscription Agreement of Service, and then click Buy Now.
      2. On the Confirm Order page, confirm the information about the order and click Pay.
    On the Instances page, click the name of the instance for which you upgraded the configurations. On the Instance Details page, view the new configurations of the instance.

Downgrade the configurations of an instance

Important
  • You can downgrade only the configurations of subscription instances that are in the Running state.
  • You can downgrade only the configurations of subscription instances. You cannot downgrade the configurations of pay-as-you-go instances or instances of the Standard Edition.
  1. In the top navigation bar of the Instances page, select a region. In the instance list, click the name of the instance that you want to manage.
  2. On the Instance Details page, click Downgrade in the upper-right corner of the Overview section.
  3. Downgrade the configurations of the instance by using one of the following methods:
      1. In the configuration panel, configure the required parameters, read the terms of service, select Message Queue for RabbitMQ Subscription Agreement of Service, and then click Buy Now.
      2. In the panel that appears, confirm the information about the order and click Purchase.
      1. Click Go to Buy Page. On the Message Queue for RabbitMQ Subscription | Downgrade page, configure the required parameters to downgrade the instance configuration, read the terms of service, select Message Queue for RabbitMQ Subscription Agreement of Service, and then click Buy Now.
      2. On the Confirm Order page, confirm the information about the order and click Pay.
    On the Instances page, click the name of the instance for which you downgraded the configurations. On the Instance Details page, view the new configurations of the instance.

Renew an instance

Important
  • The resources and data of an expired instance are retained and can be restored after you renew the instance.
  • The resources and data of a released or deleted instance are not retained and cannot be restored.
  1. In the top navigation bar of the Instances page, select a region. In the instance list, click the name of the instance that you want to manage.
  2. On the Instance Details page, click Renew in the upper-right corner of the Overview section.
  3. Renew the instance. Renew the instance by using one of the following methods:
      1. Select a subscription duration, read the terms of service, select Message Queue for RabbitMQ Subscription Terms of Service, and then click Buy Now.
      2. In the Unpaid Orders panel, confirm the information about the order and click Purchase.
      1. Click Go to Buy Page. On the Message Queue for RabbitMQ Subscription | Renew page, specify a subscription duration, read the terms of service, select Message Queue for RabbitMQ Subscription Terms of Service, and then click Buy Now.
      2. On the Purchase page, confirm the information about the order and click Subscribe.
    Note If you do not renew an instance at your earliest opportunity and the payment for the instance becomes overdue, the instance becomes unavailable after the instance expires. We recommend that you select auto-renewal when you create an instance.
    In the Basic Information section of the Instance Details page, you can view the value of the Expired At parameter of the instance after renewal.