Modifying Details of a DCS Instance
Function
This API is used to modify the information about a DCS instance, including the instance name, description, port, backup policy, start and end time of the maintenance window, and security group.
Calling Method
For details, see Calling APIs.
URI
PUT /v2/{project_id}/instances/{instance_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
instance_id |
Yes |
String |
Instance ID. |
project_id |
Yes |
String |
Project ID. For details, see Obtaining a Project ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
No |
String |
Instance name. An instance name can contain letters, digits, underscores (_), and hyphens (-) and must start with a letter. When you create only one instance at a time, the value of this parameter can contain 4 to 64 characters. When you create multiple instances at a time, the value of this parameter can contain 4 to 56 characters. The instances are named in the format of custom name-n, where n starts from 000 and is incremented by 1. For example, if you create two instances and set the custom name to dcs_demo, the two instances are respectively named dcs_demo-000 and dcs_demo-001. |
description |
No |
String |
Description of an instance. 0–1,024 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 ".
|
port |
No |
Integer |
Port for connecting to the Redis instance. The port range is from 1 to 65535. After the port is changed, all connections to the Redis instance are interrupted, and services must connect to the new port. Only DCS Redis instances support port change. |
rename_commands |
No |
RenameCommandResp object |
Command renaming list. |
maintain_begin |
No |
String |
UTC time when the maintenance time window starts. The format is HH:mm:ss.
|
maintain_end |
No |
String |
UTC time when the maintenance time window ends. The format is HH:mm:ss.
|
security_group_id |
No |
String |
This parameter is reserved. |
instance_backup_policy |
No |
BackupPolicy object |
Backup policy. This parameter is supported when the instance type is master/standby or cluster. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
command |
No |
String |
Command COMMAND. |
flushall |
No |
String |
Command FLUSHALL. |
flushdb |
No |
String |
Command FLUSHDB. |
hgetall |
No |
String |
Command HGETALL. |
keys |
No |
String |
Command KEYS. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
backup_type |
Yes |
String |
Backup type.
|
save_days |
No |
Integer |
This parameter is mandatory when backup_type is set to manual. Retention period, in days. The value ranges from 1 to 7. The automatic backup policy is retained when automatic backup is switched to manual backup. |
periodical_backup_plan |
No |
BackupPlan object |
Backup schedule. This parameter is mandatory when backup_type is set to manual. The automatic backup policy is retained when automatic backup is switched to manual backup. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
timezone_offset |
No |
String |
Parameter description: Time zone of the backup. This parameter is no longer used. Value range: N/A. |
backup_at |
Yes |
Array of integers |
Parameter description: Day on which the backup starts every week. The automatic backup policy is retained when automatic backup is switched to manual backup. Value range: 1–7: Monday to Sunday |
period_type |
Yes |
String |
Parameter description: Interval at which backup is performed, which supports only weekly currently. The automatic backup policy is retained when automatic backup is switched to manual backup. Value range: N/A. |
begin_at |
Yes |
String |
Parameter description: UTC time when the backup starts. For example, 00:00–01:00 indicates that the backup starts at 00:00 (UTC time). The value must be on the hour. The backup interval is 1 hour. The automatic backup policy is retained when automatic backup is switched to manual backup. Value range: N/A. |
Response Parameters
Status code: 204
DCS instance modified successfully.
None
Example Requests
Changing the name of a specified instance to dcs002 and port to 6379, and configuring an auto backup policy
PUT https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id} { "name" : "dcs002", "description" : "instance description", "port" : 6379, "maintain_begin" : "18:00:00", "maintain_end" : "19:00:00", "security_group_id" : "18e9309f-f81a-4749-bb21-f74576292162", "instance_backup_policy" : { "backup_type" : "auto", "save_days" : 1, "periodical_backup_plan" : { "backup_at" : [ "1", "2", "3", "4", "6", "7" ], "period_type" : "weekly", "begin_at" : "00:00-01:00" } } }
Example Responses
None
Status Codes
Status Code |
Description |
---|---|
204 |
DCS instance modified successfully. |
400 |
Invalid request. |
500 |
Internal service error. |
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.