Modifying Instance Information
Function
This API is used to modify the name and description of an instance.
URI
PUT /v2/{project_id}/instances/{instance_id}
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. For details about how to obtain it, see Obtaining a Project ID. |
|
instance_id |
Yes |
String |
Instance ID. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
name |
No |
String |
Instance name. An instance name consists of 4 to 64 characters including letters, digits, and hyphens (-) and must start with a letter. |
|
description |
No |
String |
Description of an instance. The description supports up to 1024 characters.
NOTE:
The backslash () and quotation mark (") are special characters for JSON messages. When using these characters in a parameter value, add the escape character () before the characters, for example, \ and ".
|
|
security_group_id |
No |
String |
Security group ID. You can call the API for querying security groups to obtain the security group ID. The security group ID is in the response body. For details, see Virtual Private Cloud API Reference. |
|
enable_acl |
No |
Boolean |
Definition Whether to enable ACL. Default Value
|
|
enable_publicip |
No |
Boolean |
Definition Whether to enable public access. Range
|
|
publicip_id |
No |
String |
ID of the EIP bound to the instance. Use commas (,) to separate multiple EIP IDs. This parameter is mandatory if public access is enabled (that is, enable_publicip is set to true). |
|
enterprise_project_id |
No |
String |
Definition Enterprise project. Constraints N/A Range N/A Default Value N/A |
Response Parameters
Status code: 204
Instance information modified successfully.
None
Example Requests
Modifying the name and description of a RocketMQ instance
PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}
{
"name" : "rocketmq001",
"description" : "RocketMQ description"
}
Example Responses
None
Status Codes
|
Status Code |
Description |
|---|---|
|
204 |
Instance information modified successfully. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
