更新时间:2025-11-14 GMT+08:00

修改密码

功能介绍

修改缓存实例的密码。

URI

PUT /v2/{project_id}/instances/{instance_id}/password

表1 路径参数

参数

是否必选

参数类型

描述

instance_id

String

参数解释

实例ID。可通过DCS控制台进入实例详情界面查看。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

project_id

String

参数解释

项目ID。获取方法请参见获取项目ID

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

old_password

String

参数解释

实例旧密码。

约束限制

密码长度在8到32位之间。

取值范围

至少包含如下四种字符中的三种:

  • 小写字母

  • 大写字母

  • 数字

  • 特殊字符包括(`~!@#$%^&*()-_=+|{},<.>/?)

默认取值

不涉及。

new_password

String

参数解释

实例新密码。

约束限制

新密码不能与旧密码相同,密码长度在8到32位之间。

取值范围

至少包含如下四种字符中的三种:

  • 小写字母

  • 大写字母

  • 数字

  • 特殊字符包括(`~!@#$%^&*()-_=+|{},<.>/?)

默认取值

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

lock_time

String

参数解释

锁定时间(单位:分钟)。如果重复5次输入错误的旧密码,实例会被锁定,锁定期间不允许修改或重置密码。

取值范围

0-5

result

String

参数解释

密码修改结果。

取值范围

  • success:密码修改成功。

  • passwordFailed:密码验证失败。

  • locked:已锁定。

  • failed:密码修改失败。

lock_time_left

String

参数解释

锁定剩余时间(单位:分钟)。

取值范围

0-5

retry_times_left

String

参数解释

密码验证剩余次数。

取值范围

不涉及。

message

String

参数解释

修改结果说明信息。

取值范围

不涉及。

状态码:400

表4 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

请参见错误码

error_ext_msg

String

参数解释

扩展错误信息(暂未使用,赋值为null)。

取值范围

不涉及。

状态码:500

表5 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

请参见错误码

error_ext_msg

String

参数解释

扩展错误信息(暂未使用,赋值为null)。

取值范围

不涉及。

请求示例

修改缓存实例密码,配置旧密码和新密码。

PUT https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/password

{
  "old_password" : "XXXXXX",
  "new_password" : "XXXXXX"
}

响应示例

状态码:200

修改密码成功。

{
  "lock_time" : "0",
  "result" : "success",
  "lock_time_left" : "0",
  "retry_times_left" : "5",
  "message" : "Modify DCSInstance password success."
}

状态码

状态码

描述

200

修改密码成功。

400

非法请求。

500

内部服务错误。

错误码

请参见错误码