Changing the Password¶

Function¶

This API is used to change the password of a DCS instance.

URI¶

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

**Table 1** Path Parameters¶
Parameter	Mandatory	Type	Description
instance_id	Yes	String	Instance ID.
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID.

Request Parameters¶

**Table 2** Request body parameters¶
Parameter	Mandatory	Type	Description
old_password	Yes	String	Old password.
new_password	Yes	String	New password. The password of a DCS Redis instance must meet the following complexity requirements: Can contain 8 to 32 characters. The new password must be different from the old password. Must contain at least three of the following character types: Lowercase letters Uppercase letters Digits Special characters `~!@#$^&*()-_=+\\|{},<.>/?

Response Parameters¶

Status code: 200

**Table 3** Response body parameters¶
Parameter	Type	Description
lock_time	String	Lock duration, in minutes. If the authentication fails and the account is locked, a response is returned and is not null. During password modification, after 5 failed password attempts, the instance will be locked and the password cannot be changed or reset for 5 minutes.
result	String	Password change result: success: Password is changed successfully. passwordFailed: Password authentication failed. locked: The account has been locked. failed: Password change failed.
lock_time_left	String	Remaining time before the account is unlocked, in minutes. When the account is locked, a response is returned and is not null.
retry_times_left	String	Number of remaining password attempts. If the authentication fails, a response is returned and is not null.
message	String	Modification result description.

Status code: 400

**Table 4** Response body parameters¶
Parameter	Type	Description
error_msg	String	Error message.
error_code	String	Error code.
error_ext_msg	String	Extended error information. This parameter is not used currently and is set to null.

Status code: 500

**Table 5** Response body parameters¶
Parameter	Type	Description
error_msg	String	Error message.
error_code	String	Error code.
error_ext_msg	String	Extended error information. This parameter is not used currently and is set to null.

Example Requests¶

Changing the password of the DCS instance by entering the old and new passwords

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

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

Example Responses¶

Status code: 200

Password is changed successfully.

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

Status Codes¶

Status Code	Description
200	Password is changed successfully.
400	Invalid request.
500	Internal service error.

Error Codes¶

See Error Codes.

last updated: 2025-04-08 09:08 UTC - commit: c0acbc0c7d0100e2761232ae893d6a552340fcfd