UpdateInstance - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Updates the basic information and specifications of an ApsaraMQ for RocketMQ instance.

Operation description

Note API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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:
- The required resource types are displayed in bold characters.
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
rocketmq:UpdateInstance	update	Instance acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}	none	none

Request syntax

PATCH /instances/{instanceId}

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The ID of the instance whose basic information and specifications you want to update.	rmq-cn-7e22ody****
body	object	No	The request body.
instanceName	string	No	The updated name of the instance.	test_instance
remark	string	No	The updated description of the instance.	This is the remark for test.
networkInfo	object	No	The updated network information about the instance.
internetInfo	object	No	The information about the Internet over which the instance is accessed. This parameter takes effect only if the Internet access feature is enabled for the instance.
ipWhitelist	array	No	The whitelist that includes the IP addresses that are allowed to access the ApsaraMQ for RocketMQ broker over the Internet. If you do not configure an IP address whitelist, all CIDR blocks are allowed to access the ApsaraMQ for RocketMQ broker over the Internet. If you configure an IP address whitelist, only the IP addresses in the whitelist are allowed to access the ApsaraMQ for RocketMQ broker over the Internet.
	string	No	The IP addresses in the whitlist.	192.168.x.x/24
productInfo	object	No	Additional configurations of the instance.
sendReceiveRatio	float	No	The ratio of the number of messages that you can send to the number of messages that you can receive on the instance. Value values: 0.25 to 1.	0.5
autoScaling	boolean	No	Specifies whether to enable the elastic transactions per second (TPS) feature for the instance. Valid values: true false After you enable the elastic TPS feature for an ApsaraMQ for RocketMQ instance, you can use a specific number of TPS that exceeds the specification limit. You are charged for using the elastic TPS feature. For more information, see Computing fees. Note The elastic TPS feature is supported only by specific instance editions. For more information, see Instance editions.	true
messageRetentionTime	integer	No	The retention period of messages. Unit: hours. For information about the valid values of this parameter, see the "Limits on resource quotas" section of the Limits topic. ApsaraMQ for RocketMQ supports serverless scaling of message storage. You are charged storage fees based on your actual storage usage. You can change the retention period of messages to manage storage capacity. For more information, see Storage fees.	72
traceOn	boolean	No	Specifies whether to enable the message trace feature. true false This parameter is not in use. By default, the message trace feature is enabled for ApsaraMQ for RocketMQ instances, regardless of whether this parameter is configured.	true
aclInfo	object	No	The access control list for the instance.
aclTypes	array	No	The authentication type of the instance.
	string	No	The authentication type of the instance. Valid values: default: intelligent identity authentication apache_acl:access control list (ACL) identity authentication	apache_acl
defaultVpcAuthFree	boolean	No	Indicates whether the authentication-free in VPCs feature is enabled. Indicates whether the authentication-free in VPCs feature is enabled. Valid values: true false	false

Response parameters

Parameter	Type	Description	Example
	object	The response object.
requestId	string	The ID of the request. The system generates a unique ID for each request. You can troubleshoot issues based on the request ID.	AA87DE09-DA44-52F4-9515-78B1B607****
success	boolean	Indicates whether the call is successful.	true
data	boolean	The result data that is returned.	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

Sample success responses

JSONformat

{
  "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

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

Change history

Change time	Summary of changes	Operation
2024-03-29	The internal configuration of the API is changed, but the call is not affected	View Change Details
2023-10-09	The internal configuration of the API is changed, but the call is not affected	View Change Details
2022-12-15	The internal configuration of the API is changed, but the call is not affected	View Change Details