OnsInstanceUpdate - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Updates the name and description of a 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.

A maximum of eight ApsaraMQ for RocketMQ instances can be deployed in each region.

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
mq:UpdateInstance	Write	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Remark	string	No	The updated description of the instance. If you do not configure this parameter, the instance description remains unchanged.	Updateddescription
InstanceName	string	Yes	The new name of the instance. The name must meet the following rules: The name of the instance must be unique in the region where the instance is deployed. The name must be 3 to 64 characters in length and can contain letters, digits, hyphens (-), underscores (_), and Chinese characters. If you do not configure this parameter, the instance name remains unchanged.	Updatedname
InstanceId	string	Yes	The ID of the instance whose name or description you want to update.	MQ_INST_188077086902****_BXSuW61e

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.	A07E3902-B92E-44A6-B6C5-6AA111111****

Examples

Sample success responses

JSONformat

{
  "RequestId": "A07E3902-B92E-44A6-B6C5-6AA111111****"
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history

Update the name and description of an instance in the console

You can also update the name and description of an instance in the ApsaraMQ for RocketMQ console. For more information, see Manage instances.