Help Center/ Cloud Search Service/ API Reference/ API V1/ Kibana/Dashboards Public Network Access/ Enabling Kibana/Dashboards Public Network Access
Updated on 2025-11-28 GMT+08:00
View PDF

Enabling Kibana/Dashboards Public Network Access

Function

This API is used to enable Kibana/Dashboards public network access.

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/publickibana/open

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 Kibana public network access you want to enable. 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

eip_size

Yes

Integer

Bandwidth. Unit: Mbit/s

elb_white_list

No

StartKibanaPublicReqElbWhitelist object

ELB whitelist.
Table 3 StartKibanaPublicReqElbWhitelist

Parameter

Mandatory

Type

Description

enable_white_list

Yes

Boolean

Whether to enable the whitelist function.

  • true: The whitelist is enabled.

  • false: The whitelist is disabled.

white_list

Yes

String

Whitelist.

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

Enable public network access for Kibana or OpenSearch Dashboards.

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

{
  "eip_size" : 5,
  "elb_white_list" : {
    "enable_white_list" : true,
    "white_list" : "192.168.0.xx"
  },
  "is_auto_pay" : 1
}

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.