All Products
Search

This Product

    ApsaraMQ for RabbitMQ:UpdateInstance

    Document Center

    ApsaraMQ for RabbitMQ:UpdateInstance

    Last Updated:Aug 06, 2026

    Updates an ApsaraMQ for RabbitMQ instance to upgrade or downgrade its specifications.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    amqp:UpdateInstance

    update

    *Instance

    acs:amqp:{#regionId}:{#accountId}:/instances/{#instanceId}
    • amqp:InstanceType
    • amqp:SupportEIP
    • amqp:ServerlessChargeType
    		 None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    ClientToken

    string

    No

    The client token.

    c2c5d1274axxxxxxxx
    InstanceId

    string

    Yes

    The ID of the ApsaraMQ for RabbitMQ instance.

    amqp-cn-jtexxxxx
    ModifyType

    string

    Yes

    The type of specification change. Valid values:

    • UPGRADE: upgrade.

    • DOWNGRADE: downgrade.

    UPGRADE
    InstanceType

    string

    No

    The instance type. Valid values for subscription instances:

    • professional: Professional Edition.

    • enterprise: Enterprise Edition.

    • vip: Platinum Edition.

    You do not need to specify this parameter for pay-as-you-go instances.

    professional
    ServerlessChargeType

    string

    No

    The billing type of pay-as-you-go (Serverless) instances. Valid values:

    • onDemand: pay-as-you-go.

    onDemand
    MaxPrivateTps

    integer

    No

    The peak TPS for private network traffic. Unit: transactions per second.

    1000
    SupportEip

    boolean

    No

    Specifies whether public network access is supported.

    false
    MaxEipTps

    integer

    No

    The peak TPS for public network traffic. Unit: transactions per second.

    128
    QueueCapacity

    integer

    No

    The maximum number of queues.

    1000
    MaxConnections

    integer

    No

    The maximum number of connections.

    1000
    StorageSize

    integer

    No

    The log broker space.

    7
    SupportTracing

    boolean

    No

    Specifies whether the message tracing feature is enabled.

    false
    TracingStorageTime

    integer

    No

    The retention period of message traces.

    3
    ProvisionedCapacity

    integer

    No

    The reserved TPS capacity for reserved + elastic instances.

    2000
    Edition

    string

    No

    The deployment architecture of the Serverless instance. Valid values:

    • shared: shared architecture. This value applies to reserved + elastic (shared) and pay-as-you-go editions.

    • dedicated: dedicated architecture. This value applies to the reserved + elastic (dedicated) edition.

    shared

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    The common parameter. The ID of each request is unique and can be active for troubleshooting.

    628705FD-03EE-4ABE-BB21-E1672960***
    Code

    integer

    The response code. A value of 200 indicates success.

    200
    Message

    string

    The response message.

    InstanceNotExist
    Data

    any

    The response data, which includes orderId and instanceId. Example:

    "Data": {
    "instanceId": "amqp-cn-xxxxx",
    "orderId": 22222
  }

    {'instanceId': 'rabbitmq-serverless-cn-lf63qsjlf06', 'orderId': 234170302080010}
    Success

    string

    Indicates whether the request was successful.

    true
    StatusCode

    string

    The status code.

    200

    Examples

    Success response

    JSON format

    {
  "RequestId": "628705FD-03EE-4ABE-BB21-E1672960***",
  "Code": 200,
  "Message": "InstanceNotExist",
  "Data": "{'instanceId': 'rabbitmq-serverless-cn-lf63qsjlf06', 'orderId': 234170302080010}",
  "Success": "true",
  "StatusCode": "200"
}

    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.
    400 UpDowngradeConfigNoChange The upgrade or downgrade configuration is not changed. The upgrade or downgrade configuration is not changed, please re-select
    403 UnauthorizedOperation The request has failed due to unauthorized operation. The request has failed due to unauthorized operation.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.