You can call this operation to update the name and description of a Message Queue for Apache RocketMQ instance.

Note the following when calling this operation:

  • By default, only Alibaba Cloud accounts can call this operation. Resource Access Management (RAM) users can call this operation only after being authorized.
  • A maximum of eight Message Queue for Apache RocketMQ instances can be deployed in each region.
  • The name of a Message Queue for Apache RocketMQ instance must be unique in the region where the Message Queue for Apache RocketMQ instance is deployed.

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_111111111111_DOxxxxxx

The ID of the Message Queue for Apache RocketMQ instance that you want to update.
InstanceName String No new name

The new name of the Message Queue for Apache RocketMQ instance. The value must be 3 to 64 Chinese or English characters in length. If you do not specify this parameter, the instance name will not be modified. This parameter must be specified if the Remark parameter is left empty.

Remark String No New description

The description of the Message Queue for Apache RocketMQ instance. If you do not specify this parameter, the description will not be modified. This parameter must be specified if the InstanceName parameter is left empty.

Response parameters

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

The ID of the request. This is a common parameter that facilitates troubleshooting and fault locating.

Examples

Sample requests

http(s)://[Endpoint]/? Action=OnsInstanceUpdate
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&InstanceName=new name
&Remark=New description
&<Common request parameters>

Sample success responses

XML format 

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

JSON format 

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

Error codes

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