All Products
Search
Document Center

ApsaraMQ for RabbitMQ:UpdateInstanceName

Last Updated:Nov 04, 2026

Updates the name of an MSMQ for RabbitMQ instance. By default, the instance name is the instance ID. You can modify the instance name to easily identify the instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

InstanceId

string

Yes

The ID of the MSMQ for RabbitMQ instance whose name you want to update.

amqp-cn-zvp2ajsj****

InstanceName

string

Yes

The new name of the instance. The value is not limited. We recommend that the name be no more than 64 characters in length.

amqp_test

Response elements

Element

Type

Description

Example

object

Code

integer

The status code.

200

Message

string

The error message returned if an error occurs.

InstanceNotExist

Data

string

The returned data.

true

RequestId

string

The request ID.

6DC68EC9-0E76-5435-B8C0-FF9492B4****

Success

boolean

Indicates whether the operation was successful.

true

Examples

Success response

JSON format

{
  "Code": 200,
  "Message": "InstanceNotExist",
  "Data": "true",
  "RequestId": "6DC68EC9-0E76-5435-B8C0-FF9492B4****",
  "Success": true
}

Error codes

HTTP status code

Error code

Error message

Description

500 InternalError The request processing has failed due to some unknown error. The request processing has failed due to some unknown error.
404 InstanceNotExist The instance resource does not exist. The instance resource does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.