調(diào)用UpdatePublicWhiteIps,更新指定Elasticsearch實(shí)例的公網(wǎng)地址訪問白名單。
注意事項(xiàng)
- 當(dāng)實(shí)例狀態(tài)為生效中(activating)、失效(invalid)和凍結(jié)(inactive)時(shí),無法更新實(shí)例的公網(wǎng)地址訪問白名單。
- 您可以通過兩種方式更新白名單:IP白名單列表和IP白名單組。兩種方式不能同時(shí)使用,且除了InstanceId和clientToken外,兩種方式支持配置的參數(shù)也不同,具體如下:
- IP白名單列表:publicIpWhitelist
- 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代碼示例。
請求頭
該接口使用公共請求頭,無特殊請求頭。請參見公共請求參數(shù)文檔。
請求語法
PATCH|POST /openapi/instances/{InstanceId}/public-white-ips HTTP/1.1
請求參數(shù)
名稱 | 類型 | 位置 | 是否必選 | 示例值 | 描述 |
---|---|---|---|---|---|
InstanceId | String | Path | 是 | es-cn-tl329rbpc0001**** |
實(shí)例ID。 |
clientToken | String | Query | 否 | 5A2CFF0E-5718-45B5-9D4D-70B3FF**** |
用于保證請求的冪等性。由客戶端生成該參數(shù)值,要保證在不同請求間唯一,最大不超過64個(gè)ASCII字符。 |
modifyMode | String | Query | 否 | Cover |
修改方式,取值含義如下:
|
RequestBody
參數(shù) |
類型 |
是否必選 |
示例值 |
描述 |
---|---|---|---|---|
publicIpWhitelist |
List<String> |
是 |
["0.0.0.0/0","0.0.0.0/1"] |
IP地址白名單列表。whiteIpGroup為空時(shí)可用,該參數(shù)值會(huì)更新Default白名單分組中的IP白名單配置。 不支持同時(shí)配置publicIpWhitelist和whiteIpGroup。 |
whiteIpGroup |
Object |
否 |
以白名單組方式更新實(shí)例白名單配置,僅支持更新一個(gè)白名單組。 不支持同時(shí)配置publicIpWhitelist和whiteIpGroup。 |
|
└ groupName |
String |
否 |
test_group_name |
白名單組的組名。如果選填了whiteIpGroup參數(shù),則該參數(shù)必填。 |
└ ips |
List<String> |
否 |
["0.0.0.0", "10.2.XX.XX"] |
白名單組中的IP列表。如果選填了whiteIpGroup參數(shù),則該參數(shù)必填。 |
- 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 | C82758DD-282F-4D48-934F-92170A33**** |
請求ID。 |
Result | Object |
返回結(jié)果。 |
|
publicIpWhitelist | Array of String | ["0.0.0.0","10.2.XX.XX","110.0.XX.XX/8"] |
公網(wǎng)地址訪問白名單列表。 |
示例
請求示例
PATCH /openapi/instances/es-cn-tl329rbpc0001****/public-white-ips HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json
{
"publicIpWhitelist": [
"110.0.XX.XX/8"
]
}
或
{
"whiteIpGroup": {
"groupName": "test_group_name",
"ips": [
"0.0.0.0",
"10.2.XX.XX"
]
}
}
正常返回示例
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Result" : {
"instanceId" : "es-cn-tl329rbpc0001****",
"version" : "7.10.0_with_X-Pack",
"description" : "test",
"nodeAmount" : 0,
"paymentType" : "postpaid",
"status" : "active",
"privateNetworkIpWhiteList" : [ "11.22.XX.XX", "0.0.XX.XX/0" ],
"enablePublic" : true,
"nodeSpec" : { },
"dataNode" : false,
"networkConfig" : {
"vpcId" : "vpc-bp1jy348ibzulk6h***",
"vswitchId" : "vsw-bp1a0mifpletdd1da****",
"vsArea" : "cn-hangzhou-h",
"whiteIpGroupList" : [ {
"groupName" : "default",
"ips" : [ "0.0.XX.XX/0", "11.22.XX.XX" ],
"whiteIpType" : "PRIVATE_ES"
}, {
"groupName" : "default",
"ips" : [ "110.0.XX.XX/9" ],
"whiteIpType" : "PUBLIC_KIBANA"
}, {
"groupName" : "default",
"ips" : [ "192.168.XX.XX/24" ],
"whiteIpType" : "PRIVATE_KIBANA"
}, {
"groupName" : "default",
"ips" : [ "110.0.XX.XX/8" ],
"whiteIpType" : "PUBLIC_ES"
}, {
"groupName" : "test_group_name",
"ips" : [ "0.0.0.0", "10.2.XX.XX" ],
"whiteIpType" : "PUBLIC_ES"
} ],
"type" : "vpc"
},
"createdAt" : "2021-07-21T01:29:38.510Z",
"updatedAt" : "2021-07-21T06:40:32.438Z",
"commodityCode" : "elasticsearch",
"extendConfigs" : [ {
"configType" : "usageScenario",
"value" : "log"
}, {
"configType" : "maintainTime",
"maintainStartTime" : "02:00Z",
"maintainEndTime" : "06:00Z"
}, {
"configType" : "aliVersion",
"aliVersion" : "ali1.4.0"
}, {
"configType" : "followCube",
"followClusterEnabled" : true
} ],
"endTime" : 4782556800000,
"clusterTasks" : [ ],
"vpcInstanceId" : "es-cn-tl329rbpc0001****-worker",
"resourceGroupId" : "rg-acfmxxkk2p7****",
"zoneCount" : 1,
"protocol" : "HTTP",
"zoneInfos" : [ {
"zoneId" : "cn-hangzhou-h",
"status" : "NORMAL"
} ],
"instanceType" : "elasticsearch",
"inited" : true,
"tags" : [ {
"tagKey" : "acs:rm:rgId",
"tagValue" : "rg-acfmxxkk2p7****"
} ],
"serviceVpc" : true,
"domain" : "es-cn-tl329rbpc0001****.elasticsearch.aliyuncs.com",
"port" : 9200,
"esVersion" : "7.10.0_with_X-Pack",
"esConfig" : {
"action.destructive_requires_name" : "true",
"xpack.watcher.enabled" : "false",
"action.auto_create_index" : "+.*,-*"
},
"esIPWhitelist" : [ "11.22.XX.XX", "0.0.XX.XX/0" ],
"esIPBlacklist" : [ ],
"kibanaProtocol" : "HTTPS",
"kibanaIPWhitelist" : [ "::1", "110.0.XX.XX/9" ],
"kibanaPrivateIPWhitelist" : [ "192.168.XX.XX/24" ],
"publicIpWhitelist" : [ "0.0.0.0", "10.2.XX.XX", "110.0.XX.XX/8" ],
"kibanaDomain" : "es-cn-tl329rbpc0001****.kibana.elasticsearch.aliyuncs.com",
"kibanaPort" : 5601,
"kibanaPrivateDomain" : "es-cn-tl329rbpc0001****-kibana.internal.elasticsearch.aliyuncs.com",
"kibanaPrivatePort" : 5601,
"publicPort" : 9200,
"publicDomain" : "es-cn-tl329rbpc0001****.public.elasticsearch.aliyuncs.com",
"haveKibana" : true,
"instanceCategory" : "IS",
"dedicateMaster" : false,
"advancedDedicateMaster" : false,
"masterConfiguration" : { },
"haveClientNode" : false,
"warmNode" : true,
"warmNodeConfiguration" : {
"spec" : "elasticsearch.d1.2xlarge",
"amount" : 3
},
"clientNodeConfiguration" : { },
"kibanaConfiguration" : {
"spec" : "elasticsearch.n4.small",
"amount" : 1,
"disk" : 0
},
"elasticDataNodeConfiguration" : { },
"haveElasticDataNode" : false,
"dictList" : [ {
"name" : "SYSTEM_MAIN.dic",
"fileSize" : 2782602,
"sourceType" : "ORIGIN",
"type" : "MAIN"
}, {
"name" : "SYSTEM_STOPWORD.dic",
"fileSize" : 132,
"sourceType" : "ORIGIN",
"type" : "STOP"
} ],
"synonymsDicts" : [ ],
"ikHotDicts" : [ ],
"aliwsDicts" : [ ],
"haveGrafana" : false,
"haveCerebro" : false,
"enableKibanaPublicNetwork" : true,
"enableKibanaPrivateNetwork" : true,
"advancedSetting" : {
"gcName" : "CMS"
},
"enableMetrics" : true,
"readWritePolicy" : {
"writeHa" : false
}
},
"RequestId" : "9E5466DE-E29A-4F87-9019-4AA7B80E60DE"
}
錯(cuò)誤碼
HttpCode | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
---|---|---|---|
400 | InstanceActivating | Instance is activating. | 實(shí)例目前處于生效中。 |
400 | InstanceNotFound | The instanceId provided does not exist. | 實(shí)例找不到,請核對實(shí)例狀態(tài)。 |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。