Call ModifyWhiteIps to update the access whitelist of the specified instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request header

This operation uses common request parameters only. For more information, see Common parameters.

Request syntax

PATCH|POST /openapi/instances/[InstanceId]/actions/modify-white-ips HTTPS|HTTP

Request parameters

Parameter Type Required Example Description
InstanceId String Yes es-cn-0pp1jxvcl000z****

The ID of the instance.
clientToken String No 5A2CFF0E-5718-45B5-9D4D-70B3FF****

A unique token generated by the client to guarantee the idempotency of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.

RequestBody

The following parameters must be specified in the RequestBody to specify the whitelist information.

Parameter

Type

Required

Example

Description

whiteIpList

List<String>

Yes

["0.0.0.0/0","0.0.0.0/1"]

The list of IP addresses in the whitelist.

nodeType

String

Yes

KIBANA

The type of the cluster. Valid values: WORKER(Elasticsearch cluster) and KIBANA(Kibana cluster).

networkType

String

Yes

PRIVATE

The network type of the instance. Valid values: PRIVATE and PUBLIC.

Example:


{
   "whiteIpList": [
    "0.0.0.0/0",
    "0.0.0.0/1"
],
"nodeType":"WORKER",
"networkType":"PUBLIC"
}

Response parameters

Parameter Type Example Description
RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****

The ID of the request.
Result Boolean true

Return results:

  • true: whitelist updated successfully
  • false: whitelist updated failed

Examples

Sample requests

PATCH /openapi/instances/es-cn-0pp1jxvcl000z****/actions/modify-white-ips HTTP/1.1
Common request parameters
{
   "whiteIpList": [
    "0.0.0.0/0",
    "0.0.0.0/1"
],
"nodeType":"WORKER",
"networkType":"PUBLIC"
}

Sample success responses

XML format 

<Result>true</Result>
<RequestId>EB03B04E-4700-4EC2-A4D6-9B623F09****</RequestId>

JSON format 

{
    "Result": true,
    "RequestId": "EB03B04E-4700-4EC2-A4D6-9B623F09****"
}

Error codes

For a list of error codes, visit the API Error Center.