Updated on 2023-04-14 GMT+08:00

Disabling Kibana Public Access

Function

This API is used to disable public network access to Kibana.Yearly/Monthly clusters cannot disable public access using APIs.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

PUT /v1.0/{project_id}/clusters/{cluster_id}/publickibana/close

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 disable.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

eipSize

No

Integer

Bandwidth. Unit: Mbit/s

elbWhiteList

No

StartKibanaPublicReqElbWhitelist object

ELB whitelist.

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

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

{
  "eipSize" : 5,
  "elbWhiteList" : {
    "enableWhiteList" : true,
    "whiteList" : "192.168.0.xx"
  }
}

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.