更新时间:2022-05-09 GMT+08:00
分享

修改密码

功能介绍

修改缓存实例的密码。

调试

您可以在API Explorer中调试该接口,并获取该接口关联的CLI示例: hcloud DCS UpdatePassword

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

instance_id

String

实例ID。

project_id

String

项目ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

old_password

String

旧密码

new_password

String

新密码

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

lock_time

String

锁定时间。验证失败时和锁定时该参数返回不为null

result

String

密码修改结果:

  • 成功:success;

  • 密码验证失败:passwordFailed;

  • 已锁定:locked;

  • 失败:failed。

枚举值:

  • success

  • passwordFailed

  • locked

  • failed

lock_time_left

String

锁定剩余时间。锁定时该参数返回不为null

retry_times_left

String

密码验证剩余次数。验证失败时该参数返回不为null

message

String

修改结果说明信息。

状态码: 400

表4 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息

最大长度:1024

error_code

String

错误码

最大长度:9

error_ext_msg

String

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

最大长度:1024

状态码: 500

表5 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息

最大长度:1024

error_code

String

错误码

最大长度:9

error_ext_msg

String

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

最大长度:1024

请求示例

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

内部服务错误。

错误码

请参见错误码

分享:

    相关文档

    相关产品

关闭导读