Help Center/ Cloud Search Service/ API Reference/ APIs/ Public Network Access/ Enabling the Public Network Access Control Whitelist
Updated on 2024-10-17 GMT+08:00

Enabling the Public Network Access Control Whitelist

Function

This API is used to enable the public network access control whitelist.

Debugging

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

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/public/whitelist/update

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

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

whiteList

Yes

String

IP address of the user for whom the whitelist is enabled.

Response Parameters

None

Example Requests

Enable the public network access control whitelist.

POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/public/whitelist/update

{
  "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.