Updates the name and description of a Message Queue for Apache RocketMQ instance.

Usage notes

A maximum of eight Message Queue for Apache RocketMQ instances can be deployed in each region.

QPS limit

Each Alibaba Cloud account can call this operation up to 10 times per second. If the number of requests that you send each second to call this operation exceeds the queries per second (QPS) limit, throttling is triggered. This may interrupt your business. For more information, see QPS limits.

Authorization

By default, only Alibaba Cloud accounts can call this operation. A Resource Access Management (RAM) user can call this operation only after the RAM user is granted the required permissions. The following table describes the required permissions to call this operation. For more information, see Policies and examples.

API

Action

Resource

OnsInstanceUpdate

mq:QueryInstanceBaseInfo

mq:UpdateInstance

acs:mq:*:*:{instanceId}

Request parameters

Parameter Type Required Example Description
Action String Yes OnsInstanceUpdate

The operation that you want to perform. Set the value to OnsInstanceUpdate.

Remark String No Updateddescription

The updated description of the instance. If you do not configure this parameter, the instance description remains unchanged.

InstanceName String Yes Updatedname

The updated name of the instance. Configure this parameter based on 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.
InstanceId String Yes MQ_INST_188077086902****_BXSuW61e

The ID of the instance of which you want to update the name or description.

Response parameters

Parameter Type Example Description
RequestId String A07E3902-B92E-44A6-B6C5-6AA111111****

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.

Examples

Sample requests

http(s)://ons.cn-hangzhou.aliyuncs.com/?Action=OnsInstanceUpdate
&InstanceId=MQ_INST_188077086902****_BXSuW61e
&InstanceName=Updatedname
&Remark=Updateddescription
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<OnsInstanceUpdateResponse>
<RequestId>A07E3902-B92E-44A6-B6C5-6AA111111****</RequestId>
</OnsInstanceUpdateResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, visit the API Error Center.

Update the name and description of an instance by using the console

Besides calling the OnsInstanceUpdate operation, you can use the Message Queue for Apache RocketMQ console to update the name and description of an instance. For information about how to use the Message Queue for Apache RocketMQ console to update the name and description of an instance, see Manage instances.