Modifying Instance Information
Function
This API is used to modify the instance information.
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 starts with a letter, consists of 4 to 64 characters, and can contain only letters, digits, underscores (_), and hyphens (-). |
description |
No |
String |
Instance description. The description can contain a maximum of 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 ". |
maintain_begin |
No |
String |
Time at which the maintenance time window starts. The format is HH:mm:ss.
|
maintain_end |
No |
String |
Time at which the maintenance time window ends. The format is HH:mm:ss.
|
security_group_id |
No |
String |
Security group ID. To obtain it, log in to the VPC console and view the security group ID on the security group details page. |
retention_policy |
No |
String |
Capacity threshold policy. Options:
|
enterprise_project_id |
No |
String |
Enterprise project. |
Response Parameters
None
Example Requests
-
Modifying the name and description of an instance.
PUT https://{endpoint}/v2/{project_id}/instances/{instance_id} { "name" : "kafka001", "description" : "kafka description" }
-
Modifying the name, description, and maintenance time window of an instance.
PUT https://{endpoint}/v2/{project_id}/instances/{instance_id} { "name" : "dms002", "description" : "instance description", "maintain_begin" : "02:00:00", "maintain_end" : "06:00:00" }
-
Changing the capacity threshold policy.
PUT https://{endpoint}/v2/{project_id}/instances/{instance_id} { "retention_policy" : "time_base" }
Example Responses
None
Status Codes
Status Code |
Description |
---|---|
204 |
The instance information is 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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot