調用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"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。