Updated on 2024-11-26 GMT+08:00

Resetting a Password

Function

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

URI

POST /v2/{project_id}/instances/{instance_id}/password/reset

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

new_password

No

String

New password.

no_password_access

No

Boolean

Whether to change the DCS instance to password-free.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

retry_times_left

String

Number of remaining password attempts.

lock_time

String

Lock duration.

lock_time_left

String

Remaining time before the account is unlocked.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

Maximum: 1024

error_code

String

Error code.

Maximum: 9

error_ext_msg

String

Extended error information. This parameter is not used currently and is set to null.

Maximum: 1024

Status code: 500

Table 5 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

Maximum: 1024

error_code

String

Error code.

Maximum: 9

error_ext_msg

String

Extended error information. This parameter is not used currently and is set to null.

Maximum: 1024

Example Requests

Resetting the password of the DCS instance by entering a new password

POST https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/password/reset

{
  "new_password" : "xxxxxx",
  "no_password_access" : false
}

Example Responses

Status code: 200

The password is changed successfully.

{
  "lock_time" : "0",
  "lock_time_left" : "0",
  "retry_times_left" : "5"
}

Status Codes

Status Code

Description

200

The password is changed successfully.

400

Invalid request.

500

Internal service error.

Error Codes

See Error Codes.