Changing the Security Mode
Function
This API is used to configure the security mode of an Elasticsearch or OpenSearch cluster. The security mode settings for clusters include:
-
Security mode + HTTP: strikes a balance between performance and security. Make sure the cluster is deployed in a secure environment. Do not expose the cluster's network interface to the public network.
-
Security mode + HTTPS: prioritizes security and in-transit data encryption, and allows public network access.
Calling Method
For details, see Calling APIs.
URI
POST /v1.0/{project_id}/clusters/{cluster_id}/mode/change
| 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 Range Project ID of an account. The value contains 32 characters, consisting of lowercase letters and digits. Default Value N/A |
| cluster_id | Yes | String | Definition ID of the target cluster. For details about how to obtain the cluster ID, see Obtaining the Cluster ID. Constraints N/A Range The value is a UUID containing 36 characters. Default Value N/A |
Request Parameters
Response Parameters
Status code: 200
Request succeeded.
None
Example Requests
Change the security mode of the current cluster.
POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/mode/change
{
"authority_enable" : true,
"admin_pwd" : "{admin_pwd}",
"https_enable" : true
} Example Responses
None
Status Codes
| Status Code | Description |
|---|---|
| 200 | Request succeeded. |
| 400 | Invalid request. Modify the request before retry. |
| 404 | The requested resource could not be found. Modify the request before retry. |
Error Codes
See Error Codes.