Updates the name and description of a Message Queue for Apache RocketMQ instance.
When you call this operation, note that:
- By default, only Alibaba Cloud accounts can call this operation. Resource Access Management (RAM) users can call this operation only after the RAM users are 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 instance is deployed.
Debugging
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 Message Queue for Apache RocketMQ instance. |
InstanceName | String | Yes | New name |
The new name of the Message Queue for Apache RocketMQ instance. The value must be 3 to 64 in length and can contain letters, digits, underscores (_), and hyphens (-). 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-6AA111111**** |
The ID of the request. |
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.