Updated on 2024-10-17 GMT+08:00

Enabling Kibana Public Access

Function

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

Debugging

You can debug this API through automatic authentication in API Explorer.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

cluster_id

Yes

String

ID of the cluster whose Kibana public access you want to enable.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

eipSize

Yes

Integer

Bandwidth. Unit: Mbit/s

elbWhiteList

Yes

StartKibanaPublicReqElbWhitelist object

ELB whitelist.

isAutoPay

No

Integer

Indicates whether to enable automatic payment from your Huawei Cloud account. This parameter takes effect only for yearly/monthly clusters.

  • 1: Yes. (Discounts and coupons are automatically selected. The fee will be automatically deducted from your Huawei Cloud account.) If the automatic payment fails, an unpaid order will be generated, and you need to manually complete the payment. (During manual payment, you can still modify the discounts and coupons that were automatically selected.)

  • 0: No. (The customer needs to manually pay for the bill. Discounts and coupons can be used.) The default value is 0.

Table 3 StartKibanaPublicReqElbWhitelist

Parameter

Mandatory

Type

Description

enableWhiteList

Yes

Boolean

Whether to enable the whitelist function.

  • true: The whitelist is enabled.

  • false: The whitelist is disabled.

whiteList

Yes

String

Whitelist.

Response Parameters

None

Example Requests

POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/publickibana/open

{
  "eipSize" : 5,
  "elbWhiteList" : {
    "enableWhiteList" : true,
    "whiteList" : "192.168.0.xx"
  },
  "isAutoPay" : 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.