調(diào)用UpdateWhiteIps,更新Elasticsearch實(shí)例的VPC私網(wǎng)訪問白名單。
注意事項(xiàng)
- 當(dāng)實(shí)例狀態(tài)為生效中(activating)、失效(invalid)和凍結(jié)(inactive)時(shí),無法更新信息。
- 您可以通過兩種方式更新白名單:IP白名單列表和IP白名單組。兩種方式不能同時(shí)使用,且除了InstanceId和clientToken外,兩種方式支持配置的參數(shù)也不同,具體如下:
- IP白名單列表:esIPWhitelist
- IP白名單組:modifyMode、whiteIpGroup
- 公網(wǎng)訪問白名單不支持配置私網(wǎng)IP地址,私網(wǎng)訪問白名單不支持配置公網(wǎng)IP地址。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
請(qǐng)求頭
該接口使用公共請(qǐng)求頭,無特殊請(qǐng)求頭。請(qǐng)參見公共請(qǐng)求參數(shù)文檔。
請(qǐng)求語(yǔ)法
PATCH|POST /openapi/instances/{InstanceId}/white-ips HTTP/1.1
請(qǐng)求參數(shù)
名稱 | 類型 | 位置 | 是否必選 | 示例值 | 描述 |
---|---|---|---|---|---|
InstanceId | String | Path | 是 | es-cn-npk2154oi000b**** |
實(shí)例ID。 |
clientToken | String | Query | 否 | 5A2CFF0E-5718-45B5-9D4D-70B3FF**** |
用于保證請(qǐng)求的冪等性。由客戶端生成該參數(shù)值,要保證在不同請(qǐng)求間唯一,最大不超過64個(gè)ASCII字符。 |
modifyMode | String | Query | 否 | Cover |
修改方式,可選值:
|
Object | Body | 否 |
RequestBody信息。 |
||
esIPWhitelist | Array of String | Body | 否 | ["10.61.xx.xx", "106.11.xx.xx”] |
IP地址白名單列表。whiteIpGroup為空時(shí)可用,該參數(shù)值會(huì)更新Default白名單分組中的IP白名單配置。 注意 不支持同時(shí)配置esIPWhitelist和whiteIpGroup。
|
whiteIpGroup | Object | Body | 否 |
以白名單組方式更新實(shí)例白名單配置,僅支持更新一個(gè)白名單組。 注意 不支持同時(shí)配置esIPWhitelist和whiteIpGroup。
|
|
groupName | String | Body | 否 | test_group |
白名單組的組名。如果選填了whiteIpGroup參數(shù),則該參數(shù)必填。 |
ips | Array of String | Body | 否 | ["10.2.xx.xx", "10.3.xx.xx"] |
白名單組中的IP地址列表。如果選填了whiteIpGroup參數(shù),則該參數(shù)必填。 |
whiteIpType | String | Body | 否 | PRIVATE_ES |
IP白名單的類型。固定為PRIVATE_ES,即私網(wǎng)訪問白名單。 |
- modifyMode為Cover時(shí),如果ips為空,則刪除該白名單組。如果groupName不在已有白名單組組名的列表中,則會(huì)新建一個(gè)白名單組。
- modifyMode為Delete時(shí),刪除后的ips至少需要保留一個(gè)IP地址。
- modifyMode為Append時(shí),需要保證白名單組組名為已創(chuàng)建,否則會(huì)提示NotFound的錯(cuò)誤。
返回?cái)?shù)據(jù)
名稱 | 類型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 8D58B014-BBD7-4D80-B219-00B9D5C6860C |
請(qǐng)求ID。 |
Result | Object |
返回結(jié)果。 |
|
esIPWhitelist | Array of String | ["106.11.xx.xx", "10.61.xx.xx"] |
更新后的白名單列表。 |
networkConfig | Object |
網(wǎng)絡(luò)配置。 |
|
whiteIpGroupList | Array of whiteIpGroupList |
白名單組列表。 |
|
groupName | String | test_group |
白名單組的組名。默認(rèn)包含default分組。 |
ips | Array of String | ["10.2.xx.xx", "10.3.xx.xx"] |
白名單組中的IP地址列表。 |
whiteIpType | String | PRIVATE_ES |
白名單類型。固定為PRIVATE_ES,即私網(wǎng)訪問白名單。 |
示例
請(qǐng)求示例
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"
}
錯(cuò)誤碼
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。