Changing the Cluster Administrator Password

Function

This API is used to change the admin password for a security-mode cluster.

A security-mode cluster is a cluster for which the security mode is enabled. This parameter is available only for Elasticsearch and OpenSearch clusters.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name. Constraints: N/A Value range: Project ID of the account. Default value: N/A
cluster_id	Yes	String	Definition: ID of the cluster whose password you want to change. For details about how to obtain the cluster ID, see Obtaining the Cluster ID. Constraints: N/A Value range: Cluster ID. Default value: N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
newpassword	Yes	String	Definition: New password of the cluster admin account. Constraints: This API is available only when authorityEnable is set to true during cluster creation. Value range: Must contain 8 to 32 characters. Must contain at least three of the following character types: letters, digits, and special characters ~!@#$%^&()-_=+\\|[{}];:,<.>/? Do not use the administrator name, or the administrator name spelled backwards, as the password. Default value*: N/A

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

Change the administrator password of the current cluster.

POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/password/reset

{
  "newpassword" : "xxxxxx"
}

Example Responses

None

Status Codes

Status Code	Description
200	Request succeeded.
400	Invalid request. Modify the request before retry.
409	The request could not be completed due to a conflict with the current state of the resource. The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.
412	The server did not meet one of the preconditions contained in the request.