更新时间:2023-12-12 GMT+08:00
修改实例信息
功能介绍
修改缓存实例的信息,可修改信息包括实例名称、描述、备份策略、维护时间窗开始和结束时间以及安全组。
请求消息
请求参数
参数说明见表2。
参数 |
类型 |
必选 |
说明 |
---|---|---|---|
name |
String |
否 |
实例名称。 由英文字符开头,只能由英文字母、数字、中划线和下划线组成。 创建单个实例时,名称长度为4到64位的字符串。批量创建实例时,名称长度为4到56位的字符串,且实例名称格式为“自定义名称-n”,其中n从000开始,依次递增。例如,批量创建两个实例,自定义名称为dcs_demo,则两个实例的名称为dcs_demo-000和dcs_demo-001。 |
description |
String |
否 |
实例的描述信息。 长度不超过1024的字符串。
说明:
\与"在json报文中属于特殊字符,如果参数值中需要显示\或者"字符,请在字符前增加转义字符\,比如\\或者\"。 |
instance_backup_policy |
JSON |
否 |
|
maintain_begin |
String |
否 |
维护时间窗开始时间,格式为HH:mm:ss。
|
maintain_end |
String |
否 |
维护时间窗结束时间,格式为HH:mm:ss。
|
security_group_id |
String |
否 |
安全组ID。 可从虚拟私有云服务的控制台界面或者API接口查询得到。 |
请求示例
请求URL:
PUT https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}
- 示例1:
{ "description": "instance description" }
- 示例2:
{ "name": "dcs002", "description": "instance description", "instance_backup_policy": { "backup_type": "auto", "save_days": 1, "periodical_backup_plan": { "begin_at": "00:00-01:00", "period_type": "weekly", "backup_at": [ "1", "2", "3", "4", "6", "7" ] } }, "security_group_id": "18e9309f-f81a-4749-bb21-f74576292162", "maintain_begin": "02:00:00", "maintain_end": "06:00:00" }
响应消息
响应参数
无。
响应样例
无。