调用UpdateWhiteIps，更新Elasticsearch实例的VPC私网访问白名单。

注意事项

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

调试

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

请求头

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

请求语法

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

请求参数

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

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

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

修改方式，可选值：

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

RequestBody信息。
esIPWhitelist Array of String Body 否 ["10.61.xx.xx", "106.11.xx.xx”]

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

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

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

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

白名单组的组名。如果选填了whiteIpGroup参数，则该参数必填。
ips Array of String Body 否 ["10.2.xx.xx", "10.3.xx.xx"]

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

IP白名单的类型。固定为PRIVATE_ES，即私网访问白名单。

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

返回数据

名称 类型 示例值 描述
RequestId String 8D58B014-BBD7-4D80-B219-00B9D5C6860C

请求ID。
Result Object

返回结果。
esIPWhitelist Array of String ["106.11.xx.xx", "10.61.xx.xx"]

更新后的白名单列表。
networkConfig Object

网络配置。
whiteIpGroupList Array of whiteIpGroupList

白名单组列表。
groupName String test_group

白名单组的组名。默认包含default分组。
ips Array of String ["10.2.xx.xx", "10.3.xx.xx"]

白名单组中的IP地址列表。
whiteIpType String PRIVATE_ES

白名单类型。固定为PRIVATE_ES，即私网访问白名单。
说明 以下返回示例中，本文只保证包含返回数据列表中的参数，而未提到的参数仅供参考，参数说明可参见ListInstance。程序中不能强制依赖获取这些参数。

示例

请求示例

PATCH /openapi/instances/es-cn-npk2154oi000b****/white-ips HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json
{
    "esIPWhitelist": [
        "110.0.XX.XX/8"
    ]
}
或
{
    "whiteIpGroup": {
        "groupName": "test_group_name", 
        "ips": [
            "0.0.0.0", 
            "10.2.XX.XX"
        ],
        "whiteIpType" : "PRIVATE_ES"
    }
}

正常返回示例

JSON格式 

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

{
  "Result" : {
    "instanceId" : "es-cn-xxx",
    "domain" : "es-cn-xxx.elasticsearch.aliyuncs.com",
    "description" : "aliyunes_name_test",
    "nodeAmount" : 3,
    "paymentType" : "postpaid",
    "status" : "active",
    "port" : 9200,
    "esVersion" : "5.5.3_with_X-Pack",
    "esConfig" : {
      "action.destructive_requires_name" : "true",
      "xpack.security.audit.outputs" : "index",
      "xpack.watcher.enabled" : "false",
      "xpack.security.audit.enabled" : "true",
      "action.auto_create_index" : "+.*,-*"
    },
    "esIPWhitelist" : [ "192.168.xx.xx/24" ],
    "esIPBlacklist" : [ ],
    "privateNetworkIpWhiteList" : [ "192.168.xx.xx/24" ],
    "kibanaIPWhitelist" : [ "0.0.0.0/0", "::/0" ],
    "publicIpWhitelist" : [ ],
    "kibanaDomain" : "es-cn-xxx.kibana.elasticsearch.aliyuncs.com",
    "kibanaPort" : 5601,
    "enablePublic" : false,
    "nodeSpec" : {
      "spec" : "elasticsearch.n4.small",
      "disk" : 20,
      "diskType" : "cloud_ssd"
    },
    "networkConfig" : {
      "vpcId" : "vpc-bp1uag5jj38ccmwn1****",
      "vswitchId" : "vsw-bp1knt7m4cyn5k3a7****",
      "vsArea" : "cn-hangzhou-b",
      "type" : "vpc",
      "whiteIpGroupList" : [ {
        "groupName" : "default",
        "ips" : [ "0.0.0.0", "10.2.xx.xx" ]
      }, {
        "groupName" : "test_group_name",
        "ips" : [ "10.2.xx.xx" ]
      } ]
    },
    "createdAt" : "2019-01-17T09:22:45.888Z",
    "updatedAt" : "2019-03-15T13:21:20.728Z",
    "inited" : true,
    "dedicateMaster" : false,
    "advancedDedicateMaster" : false,
    "masterConfiguration" : { },
    "haveClientNode" : false,
    "warmNode" : false,
    "warmNodeConfiguration" : { },
    "clientNodeConfiguration" : { },
    "kibanaConfiguration" : {
      "spec" : "elasticsearch.n4.small",
      "amount" : 1,
      "disk" : 0
    },
    "commodityCode" : "elasticsearch",
    "endTime" : 4703414400000,
    "dictList" : [ {
      "name" : "SYSTEM_MAIN",
      "fileSize" : 3058510,
      "type" : "MAIN",
      "sourceType" : "ORIGIN"
    }, {
      "name" : "SYSTEM_STOPWORD",
      "fileSize" : 164,
      "type" : "STOP",
      "sourceType" : "ORIGIN"
    } ],
    "synonymsDicts" : [ ],
    "ikHotDicts" : [ {
      "name" : "test",
      "fileSize" : 8,
      "type" : "MAIN",
      "sourceType" : "ORIGIN"
    } ],
    "clusterTasks" : [ ],
    "vpcInstanceId" : "es-cn-xxx-worker"
  },
  "RequestId" : "C82758DD-282F-4D48-934F-92170A3388FA"
}

错误码

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