UpdateWhiteIps - Elasticsearch

注意事項

當執行個體狀態為生效中（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"
}

錯誤碼

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