重置密码
功能介绍
重置缓存实例的密码。
URI
POST /v2/{project_id}/instances/{instance_id}/password/reset
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
instance_id |
是 |
String |
参数解释: 实例ID。可通过DCS控制台进入实例详情界面查看。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
project_id |
是 |
String |
参数解释: 项目ID。获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
new_password |
否 |
String |
参数解释: 重置的新密码。当“no_password_access”配置为“false”或未配置时,请求消息中须包含password参数。 约束限制: 密码长度在8到32位之间。 取值范围: 至少包含如下四种字符中的三种:
默认取值: 不涉及。 |
|
no_password_access |
否 |
Boolean |
参数解释: 是否重置为免密码访问缓存实例。 约束限制: 不涉及。 取值范围:
默认取值: false |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
retry_times_left |
String |
参数解释: 密码验证剩余次数。重置密码不涉及密码验证,该参数已废弃,默认返回5。 取值范围: 不涉及。 |
|
lock_time |
String |
参数解释: 锁定时间(单位:分钟)。重置密码不涉及锁定,该参数已废弃,默认返回0。 取值范围: 不涉及。 |
|
lock_time_left |
String |
参数解释: 锁定剩余时间(单位:分钟)。重置密码不涉及锁定,该参数已废弃,默认返回0。 取值范围: 不涉及。 |
|
code |
String |
参数解释: 重置密码结果编号。 取值范围: 1:重置密码成功。 |
|
message |
String |
参数解释: 重置密码结果信息。 取值范围: success |
|
ext_message |
String |
参数解释: 重置密码错误信息,若重置密码成功,则为null。 取值范围: 不涉及。 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
参数解释: 错误信息。 取值范围: 不涉及。 |
|
error_code |
String |
参数解释: 错误码。 取值范围: 请参见错误码。 |
|
error_ext_msg |
String |
参数解释: 扩展错误信息(暂未使用,赋值为null)。 取值范围: 不涉及。 |
状态码:500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
参数解释: 错误信息。 取值范围: 不涉及。 |
|
error_code |
String |
参数解释: 错误码。 取值范围: 请参见错误码。 |
|
error_ext_msg |
String |
参数解释: 扩展错误信息(暂未使用,赋值为null)。 取值范围: 不涉及。 |
请求示例
重置缓存实例密码,配置新密码。
POST https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/password/reset
{
"new_password" : "xxxxxx",
"no_password_access" : false
}
响应示例
状态码:200
重置缓存实例的密码成功。
{
"lock_time" : "0",
"lock_time_left" : "0",
"retry_times_left" : "5",
"code" : "1",
"message" : "success",
"ext_message" : null
}
状态码:400
非法请求。
{
"error_code" : "DCS.4839",
"error_msg" : "is not support reset instance password."
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
重置缓存实例的密码成功。 |
|
400 |
非法请求。 |
|
500 |
内部服务错误。 |
错误码
请参见错误码。