Modifying Kibana/Dashboards Public Network Access
Function
When public Kibana/Dashboards access has been enabled for an Elasticsearch/OpenSearch cluster, you can use this API to modify the public Kibana/Dashboards access permissions.
Calling Method
For details, see Calling APIs.
URI
POST /v1.0/{project_id}/clusters/{cluster_id}/publickibana/whitelist/update
| 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 cluster whose Kibana/Dashboards access control you want to modify. For details about how to obtain the cluster ID, see Obtaining the Cluster ID. Constraints N/A Range UUID format, 36 characters. Default Value N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| white_list | Yes | String | Definition Whitelist for Kibana/Dashboards public access control. Add the IP addresses or CIDR blocks to be whitelisted, separated by commas (,). Valid examples: 192.168.1.1,10.0.0.0/24. Constraints The following are not supported: 0.0.0.0,x.x.x.x/0, non-standard formats such as 192.168.1, or duplicate entries. Range Valid CIDR blocks or IP addresses. Default Value N/A |
Response Parameters
Status code: 200
Request succeeded.
None
Example Requests
Modify Kibana/Dashboards public network access.
POST https://{Endpoint}/v1.0/{project_id}/clusters/5c77b71c-5b35-4f50-8984-76387e42451a/publickibana/whitelist/update
{
"white_list" : "192.168.0.21"
} 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. |
Error Codes
See Error Codes.