Updated on 2025-08-06 GMT+08:00

Resetting a Password

Function

This API is used to reset the administrator password of a cluster.

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/reset-password

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

cluster_id

Yes

String

Definition

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

new_password

Yes

String

Definition

New password of the cluster administrator.

Constraints

The new password must:

  • Contain 12 to 32 characters.

  • Cannot be the username or the username backwards.

  • Contain at least three of the following four types:

    • Lowercase letters

    • Uppercase letters

    • Number

    • Special characters (~!?,.:;-_'"(){}[]/<>@#%^&*+|=)

  • Cannot be the same as previous passwords.

  • Cannot be a weak password.

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

The password is reset.

None

Example Requests

Reset the password of the cluster whose ID is 4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90 to NewPassw0rd!.

POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/reset-password

{
  "new_password" : "NewPassw0rd!"
}

Example Responses

Status code: 200

The password is reset.

{ }

Status Codes

Status Code

Description

200

The password is reset.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

Service unavailable.