调用ModifyWhiteIps，更新指定实例的访问白名单。

注意事项

  • 实例状态为生效中（activating）、失效（invalid）和冻结（inactive），无法更新信息。
  • 您可以通过两种方式更新白名单：IP白名单列表和IP白名单组。两种方式不能同时使用，且除了InstanceId和clientToken外，两种方式支持配置的参数也不同，具体如下：
    • IP白名单列表：whiteIpList、nodeType、networkType
    • IP白名单组：modifyMode、whiteIpGroup
  • 公网访问白名单不支持配置私网IP地址，私网访问白名单不支持配置公网IP地址。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求头

该接口使用公共请求头，无特殊请求头。请参见公共请求参数文档。

请求语法

PATCH|POST /openapi/instances/{InstanceId}/actions/modify-white-ips HTTP/1.1

请求参数

名称 类型 位置 是否必选 示例值 描述
InstanceId String Path 是 es-cn-0pp1jxvcl000z****

实例ID。
clientToken String Query 否 5A2CFF0E-5718-45B5-9D4D-70B3FF****

用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过64个ascii字符。
Object Body 否

请求体参数。
nodeType String Body 否 WORKER

节点类型，如果选填了whiteIpList参数，则该参数必填。可选值：

  • WORKER：Elasticsearch集群
  • KIBANA：Kibana集群
networkType String Body 否 PUBLIC

网络类型，如果选填了whiteIpList参数，则该参数必填。可选值：

  • PRIVATE：私网
  • PUBLIC：公网
modifyMode String Body 否 Cover

修改方式，可选值：

  • Cover（默认）：使用ips参数的值覆盖原IP白名单。
  • Append：在原IP白名单中增加ips参数中输入的IP地址。
  • Delete：在原IP白名单中删除ips参数中输入的IP地址，至少需要保留一个IP地址。
whiteIpList Array of String Body 否 192.168.xx.xx

IP地址白名单列表。whiteIpGroup为空时可用，该参数值会更新Default白名单分组中的IP白名单配置。

注意 不支持同时配置whiteIpList和whiteIpGroup。
whiteIpGroup Object Body 否

以白名单组方式更新实例白名单配置，仅支持更新一个白名单组。

注意 不支持同时配置whiteIpList和whiteIpGroup。
groupName String Body 否 test_group

白名单组的组名。如果选填了whiteIpGroup参数，则该参数必填。
ips Array of String Body 否 192.168.xx.xx

白名单组中的IP地址列表。如果选填了whiteIpGroup参数，则该参数必填。
whiteIpType String Body 否 PRIVATE_ES

IP白名单的类型，可选值：

  • PRIVATE_KIBANA：Kibana私网访问白名单
  • PRIVATE_ES：Elasticsearch私网访问白名单
  • PUBLIC_ES：Elasticsearch公网访问白名单
  • PUBLIC_KIBANA：Kibana公网访问白名单
注意 白名单组的增加和删除是由modifyMode为Cover的调用来实现的，Delete和Append无法实现白名单组粒度的增删，只能修改白名单组中的IP地址列表。具体说明如下：
  • modifyMode为Cover时，如果ips为空，则删除该白名单组。如果groupName不在已有白名单组组名的列表中，则会新建一个白名单组。
  • modifyMode为Delete时，删除后的ips至少需要保留一个IP地址。
  • modifyMode为Append时，需要保证白名单组组名为已创建，否则会提示NotFound的错误。

返回数据

名称 类型 示例值 描述
Result Boolean true

返回结果：

  • true：白名单更新成功
  • false：白名单更新失败
RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1DERFG

请求ID。

示例

请求示例

PATCH /openapi/instances/es-cn-0pp1jxvcl000z****/actions/modify-white-ips HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json
{
    "nodeType" : "WORKER",
    "networkType" : "PUBLIC",
    "whiteIpList": [
        "110.0.XX.XX/8"
    ]
}
或
{
    "modifyMode": "cover",
    "whiteIpGroup": {
        "groupName": "test_group_name", 
        "ips": [
            "0.0.0.0", 
            "10.2.XX.XX"
        ],
        "whiteIpType" : "PRIVATE_ES"
    }
}

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyWhiteIpsResponse>
    <Result>true</Result>
    <RequestId>5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1DERFG</RequestId>
</ModifyWhiteIpsResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Result" : true,
  "RequestId" : "5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1DERFG"
}

错误码

访问错误中心查看更多错误码。