Modifying an Instance
![](https://support.huaweicloud.com/eu/api-rabbitmq/public_sys-resources/note_3.0-en-us.png)
This API is an out-of-date version and may not be maintained in the future. Please use the API described in Modifying Instance Information.
Function
This API is used to modify the name and description of an instance.
URI
PUT /v1.0/{project_id}/instances/{instance_id}
Parameter |
Type |
Mandatory |
Description |
---|---|---|---|
project_id |
String |
Yes |
Indicates the ID of a project. |
instance_id |
String |
Yes |
Indicates the instance ID. |
Request
Request parameters
Table 2 describes the request parameters.
Parameter |
Type |
Mandatory |
Description |
---|---|---|---|
name |
String |
No |
Indicates the instance name. An instance name is a string of 4 to 64 characters that contain letters, digits, and hyphens (-). An instance name must start with a letter. |
description |
String |
No |
Indicates the description of an instance. It is a character string containing not more than 1024 characters.
NOTE:
The backslash (\) and quotation mark (") are special characters for JSON packets. When using these characters in a parameter value, add the escape character (\) before these characters, for example, \\ and \". |
maintain_begin |
String |
No |
Indicates the time at which a maintenance time window starts. Format: HH:mm:ss.
|
maintain_end |
String |
No |
Indicates the time at which a maintenance time window ends. Format: HH:mm:ss.
|
security_group_id |
String |
No |
Indicates the security group ID. |
enable_publicip |
Boolean |
No |
Indicates whether to enable public access for a RabbitMQ instance.
|
publicip_id |
String |
No |
Indicates the ID of the EIP bound to a RabbitMQ instance. This parameter is mandatory if public access is enabled (that is, enable_publicip is set to true). |
enterprise_project_id |
String |
No |
Indicates the enterprise project ID. |
Example request
Example 1:
{ "name": "dms002", "description": "instance description" }
Example 2:
{ "name": "dms002", "description": "instance description", "maintain_begin":"02:00", "maintain_end":"06:00" }
Response
Response parameters
None.
Example response
None.
Status Code
Table 3 describes the status code of successful operations. For details about other status codes, see Status Code.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.