All Products
Search
Document Center

ApsaraMQ for RabbitMQ:UpdateInstance

Last Updated:Jan 17, 2025

Upgrades or downgrades the configurations of an ApsaraMQ for RabbitMQ instance.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is 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.
OperationAccess levelResource typeCondition keyAssociated operation
amqp:UpdateInstanceupdate
*Instance
acs:amqp:{#regionId}:{#accountId}:/instances/{#instanceId}
  • amqp:InstanceType
  • amqp:SupportEIP
  • amqp:ServerlessChargeType
none

Request parameters

ParameterTypeRequiredDescriptionExample
ClientTokenstringNo

The client token.

c2c5d1274axxxxxxxx
InstanceIdstringYes

The ID of the ApsaraMQ for RabbitMQ instance.

amqp-cn-jtexxxxx
ModifyTypestringYes

The type of the configuration change. Valid values:

  • UPGRADE
  • DOWNGRADE
UPGRADE
InstanceTypestringNo

The instance edition. Valid values for subscription instances:

  • professional: Professional Edition
  • enterprise: Enterprise Edition
  • vip: Enterprise Platinum Edition.

If your instance is a pay-as-you-go instance, you do not need to configure this parameter.

professional
ServerlessChargeTypestringNo

The billing method of the serverless instance. Valid values:

  • onDemand: You are charged based on your actual usage.
onDemand
MaxPrivateTpslongNo

The peak transactions per second (TPS) for accessing the instance in a virtual private cloud (VPC).

1000
SupportEipbooleanNo

Specifies whether elastic IP addresses (EIPs) are supported.

false
MaxEipTpslongNo

The peak TPS for accessing the instance over the Internet.

128
QueueCapacityintegerNo

The maximum number of queues that can be created on the instance.

1000
MaxConnectionsintegerNo

The maximum number of connections that can be created on the instance.

1000
StorageSizeintegerNo

The size of the storage space that can be used to store messages.

7
SupportTracingbooleanNo

Specifies whether to enable the message trace feature.

false
TracingStorageTimeintegerNo

The retention period of message traces.

Valid values:

  • 3
  • 7
  • 15
3

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

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

The response code. The status code 200 indicates that the request was successful.

200
Messagestring

The returned message.

InstanceNotExist
Dataany

The returned data, which includes orderId and instanceId. Sample returned data:

"Data": {
    "instanceId": "amqp-cn-xxxxx",
    "orderId": 22222
  }
{“instanceId”: “amqp-cn-jtexxxxx”, “orderId”: 2222222}
Successstring

Indicates whether the request was successful.

true
StatusCodestring

The response code.

200

Examples

Sample success responses

JSONformat

{
  "RequestId": "628705FD-03EE-4ABE-BB21-E1672960***",
  "Code": 200,
  "Message": "InstanceNotExist",
  "Data": "{“instanceId”: “amqp-cn-jtexxxxx”, “orderId”: 2222222}",
  "Success": "true",
  "StatusCode": "200"
}

Error codes

HTTP status codeError codeError messageDescription
400INSUFFICIENT_AVAILABLE_QUOTAYour 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.
403UnauthorizedOperationThe request has failed due to unauthorized operation.The request has failed due to unauthorized operation.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-12-02The Error code has changedView Change Details
2024-11-25The request parameters of the API has changedView Change Details