UpdateInstance - ApsaraMQ for RabbitMQ - Alibaba Cloud Documentation Center

Upgrades or downgrades an ApsaraMQ for RabbitMQ instance.

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 modification type. Valid values: UPGRADE: Upgrades the instance. DOWNGRADE: Downgrades the instance.	UPGRADE
InstanceType	string	No	The instance type. This parameter is available only for subscription instances. Valid values: professional: Professional Edition enterprise: Enterprise Edition vip: Platinum Edition This parameter is not required for pay-as-you-go instances.	professional
ServerlessChargeType	string	No	The billing method of the pay-as-you-go (Serverless) instance. Valid values: onDemand: Pay-as-you-go	onDemand
MaxPrivateTps	integer	No	The peak transactions per second (TPS) for private endpoints. Unit: TPS.	1000
SupportEip	boolean	No	Specifies whether to enable Internet access.	false
MaxEipTps	integer	No	The peak TPS for public endpoints. Unit: TPS.	128
QueueCapacity	integer	No	The maximum number of queues.	1000
MaxConnections	integer	No	The maximum number of connections.	1000
StorageSize	integer	No	The message storage space.	7
SupportTracing	boolean	No	Specifies whether to enable the message trace feature.	false
TracingStorageTime	integer	No	The retention period of message traces.	3
EncryptedInstance	boolean	No	This feature is available only for dedicated instances. Specifies whether to enable data storage encryption. For dedicated instances, the EncryptedInstance and KmsKeyId properties cannot be changed. This means you cannot disable encryption or downgrade the instance to a shared type. Do not include these parameters when you call UpdateInstance to upgrade or downgrade a dedicated instance. The EncryptedInstance and KmsKeyId parameters are used when you upgrade a shared instance to an encrypted dedicated instance.	false
KmsKeyId	string	No	This feature is available only for dedicated instances. This parameter is required if EncryptedInstance is set to true. The ID of the KMS key used for data storage encryption. The key must meet the following requirements: The KMS key must be in the same region as the ApsaraMQ for RabbitMQ instance. It cannot be a service key. The key must be enabled. It must be a symmetric key, not an asymmetric key. The key must be used for encryption and decryption. If the KMS key expires or is deleted, data cannot be read or written, and the ApsaraMQ for RabbitMQ instance becomes abnormal.	key-bjj66c2a893vmhawtq5fd
ProvisionedCapacity	integer	No
Edition	string	No

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request. This is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.	628705FD-03EE-4ABE-BB21-E1672960***
Code	integer	The return code. A value of 200 indicates that the request was successful.	200
Message	string	The returned message.	InstanceNotExist
Data	any	The returned data, which includes the orderId and instanceId. For example: `"Data": { "instanceId": "amqp-cn-xxxxx", "orderId": 22222 }`	{“instanceId”: “amqp-cn-jtexxxxx”, “orderId”: 2222222}
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”: “amqp-cn-jtexxxxx”, “orderId”: 2222222}",
  "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	InstanceUpgradeOrDownGradeTopicMigrating	Data migration is in progress for an instance upgrade/downgrade. Please wait for completion.
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.