Call the UpdateInstance API to update instance information and specifications - ApsaraMQ for RocketMQ - Alibaba Cloud - ApsaraMQ for RocketMQ

Updating the basic information and specifications of a Message Queue for Apache RocketMQ instance.

Operation description

Important Alibaba Cloud's OpenAPI is a control plane API for managing and querying cloud resources. Use it on the control path only. Do not use this API on the core data path for message transport, as this can compromise service reliability.

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

rocketmq:UpdateInstance

update

*Instance

acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}

None

Request syntax

PATCH /instances/{instanceId} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The ID of the instance to update.	rmq-cn-7e22ody****

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
instanceName	string	No	The updated instance name.	test_instance
remark	string	No	The updated remark for the instance.	This is the remark for test.
networkInfo	object	No	The updated network information for the instance.
internetInfo	object	No	The internet information. This parameter is valid only if public access is enabled for the instance.
ipWhitelist	array	No	The IP address whitelist for public access. If you do not configure an IP address whitelist, the instance allows access from any public IP address by default. If you configure an IP address whitelist, only IP addresses in the whitelist can access the instance over the internet.
	string	No	An IP address or CIDR block in the public IP address whitelist.	192.168.x.x/24
productInfo	object	No	The extended configuration of the instance.
sendReceiveRatio	number	No	The message send/receive ratio. Valid values: [0.25, 1].	0.5
autoScaling	boolean	No	Specifies whether to enable burstable performance for the instance. If you enable burstable performance, the instance can exceed its baseline transactions per second (TPS) within a specific range. You are charged for the TPS that exceeds the baseline. For more information about billing, see Computing power fees. Note Burstable performance is supported only by specific instance editions. For more information about the supported instance editions, see Instance editions. Valid values: true : Enable burstable performance. false : Disable burstable performance.	true
messageRetentionTime	integer	No	The message retention period. Unit: hours. For information about the value range, see the "Message retention period" section in the Limits topic. Message storage in Message Queue for Apache RocketMQ is serverless and elastic. You are charged for your actual storage usage. You can change the message retention period to adjust your storage capacity. For more information, see Storage fees.	72
traceOn	boolean	No	Specifies whether to enable the message trace feature. This parameter is not yet in effect. Message tracing is enabled by default for all instances. Valid values: false : Disables the message trace feature. true : Enables the message trace feature.	true
aclInfo	object	No	The access control information.
aclTypes	array	No	The authentication mechanisms for the instance.
	string	No	The authentication mechanism for the instance. Valid values: default : intelligent authentication apache_acl : Apache RocketMQ ACL	apache_acl
defaultVpcAuthFree	boolean	No	Specifies whether to enable password-free access over VPCs when intelligent authentication is used. Valid values: true : Enables password-free access. false : Disables password-free access.	false

Response elements

Element	Type	Description	Example
	object	The response object.
requestId	string	The unique ID of the request, used to troubleshoot and trace issues.	AA87DE09-DA44-52F4-9515-78B1B607****
success	boolean	Indicates whether the operation succeeded.	true
data	boolean	The result of the operation.	true
code	string	The error code.	MissingInstanceId
message	string	The error message.	Parameter instanceId is mandatory for this action .
httpStatusCode	integer	The HTTP status code.	400
dynamicCode	string	The dynamic error code.	InstanceId
dynamicMessage	string	The dynamic error message.	instanceId

Examples

Success response

JSON format

{
  "requestId": "AA87DE09-DA44-52F4-9515-78B1B607****",
  "success": true,
  "data": true,
  "code": "MissingInstanceId",
  "message": "Parameter instanceId is mandatory for this action .",
  "httpStatusCode": 400,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.