更新时间：2025-06-17 GMT+08:00
修改实例信息
功能介绍
修改实例的信息，包括实例名称、实例描述、实例维护时间窗、安全组等信息。
URI
PUT /v1.0/{project_id}/instances/{instance_id}
|
参数 |
类型 |
必选 |
说明 |
|---|---|---|---|
|
project_id |
String |
是 |
项目ID。 |
|
instance_id |
String |
是 |
实例ID。 |
请求消息
请求参数
参数说明见表2。
|
参数 |
类型 |
必选 |
说明 |
|---|---|---|---|
|
name |
String |
否 |
实例名称。 由英文字符开头，只能由英文字母、数字、中划线组成，长度为4~64的字符。 |
|
description |
String |
否 |
实例的描述信息。 长度不超过1024的字符串。
说明：
\与"在json报文中属于特殊字符，如果参数值中需要显示\或者"字符，请在字符前增加转义字符\，比如\\或者\"。 |
|
maintain_begin |
String |
否 |
维护时间窗开始时间，格式为HH:mm:ss。
|
|
maintain_end |
String |
否 |
维护时间窗结束时间，格式为HH:mm:ss。
|
|
security_group_id |
String |
否 |
安全组ID。 |
|
retention_policy |
String |
否 |
容量阈值策略。 支持两种策略模式：
|
|
enterprise_project_id |
String |
否 |
企业项目。 |
请求示例
示例1 ：
PUT https://{dms_endpoint}/v1.0/{project_id}/instances/{instance_id}
{
"name": "dms002",
"description": "instance description"
}
示例2
PUT https://{dms_endpoint}/v1.0/{project_id}/instances/{instance_id}
{
"name": "dms002",
"description": "instance description",
"maintain_begin":"02:00:00",
"maintain_end":"06:00:00"
}
响应消息
响应参数
无。
响应样例
无。
父主题： 实例管理类接口
