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

The queries-per-second (QPS) limit on this operation is 10 per user. Throttling is triggered when the number of calls to this operation per second exceeds the QPS limit. Throttling may affect your business. Therefore, call this operation based on your needs. For more information, see QPS limits.

Authorization information

By default, only Alibaba Cloud accounts can call this operation. RAM users can call this operation only after they are authorized to use it. The following table lists the authorization information of this operation. For more information, see Policies and examples.

API

Action

Resource

OnsInstanceUpdate

mq:UpdateInstance

acs:mq:*:*:{instanceId}

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes OnsInstanceUpdate

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

InstanceId String Yes MQ_INST_188077086902****_BXSuW61e

The ID of the instance.
InstanceName String Yes New name

The new name of the instance. Valid values:

  • 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 (-), and underscores (_).
  • If you do not set this parameter, the instance name will not be modified.
Remark String No New description

The new instance description. If you do not set this parameter, the instance description will not be modified.

Response parameters

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

The ID of the request, which is a common parameter. Each request has a unique ID to facilitate troubleshooting and fault locating.

Examples

Sample requests

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

Sample success responses

XML format 

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

JSON format 

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

Error codes

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

Operations in the console

In addition to calling the OnsInstanceUpdate operation, you can update the name and description of an instance in the Message Queue for Apache RocketMQ console. For more information, see Manage instances.