调用UpdatePrivateNetworkWhiteIps,更新指定Elasticsearch实例的VPC私网访问白名单。
注意事项
- 当实例状态为生效中(activating)、失效(invalid)和冻结(inactive)时,无法更新实例的VPC私网访问白名单。
- 您可以通过两种方式更新白名单:IP白名单列表和IP白名单组。两种方式不能同时使用,且除了InstanceId和clientToken外,两种方式支持配置的参数也不同,具体如下:
- IP白名单列表:privateNetworkIpWhiteList
- IP白名单组:modifyMode、whiteIpGroup
- 公网访问白名单不支持配置私网IP地址,私网访问白名单不支持配置公网IP地址。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求头
该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。
请求语法
POST /openapi/instances/{InstanceId}/private-network-white-ips HTTP/1.1
请求参数
名称 | 类型 | 位置 | 是否必选 | 示例值 | 描述 |
---|
名称 | 类型 | 位置 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|---|
InstanceId | String | Path | 是 | es-cn-tl329rbpc0001**** |
实例ID。 |
clientToken | String | Query | 否 | 5A2CFF0E-5718-45B5-9D4D-70B3FF**** |
用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大不超过64个ASCII字符。 |
modifyMode | String | Query | 否 | Cover |
修改方式,取值含义如下:
|
RequestBody
参数 |
类型 |
是否必选 |
示例值 |
描述 |
---|
参数 |
类型 |
是否必选 |
示例值 |
描述 |
---|---|---|---|---|
privateNetworkIpWhiteList |
List<String> |
否 |
["0.0.XX.XX","10.2.XX.XX","192.168.XX.XX/25"] |
IP地址白名单列表。whiteIpGroup为空时可用,该参数值会更新Default白名单分组中的IP白名单配置。 不支持同时配置privateNetworkIpWhiteList和whiteIpGroup。 |
whiteIpGroup |
Object |
否 |
以白名单组方式更新实例白名单配置,仅支持更新一个白名单组。 不支持同时配置privateNetworkIpWhiteList和whiteIpGroup。 |
|
└ groupName |
String |
否 |
test_group_name |
白名单组的组名。如果选填了whiteIpGroup参数,则该参数必填。 |
└ ips |
List<String> |
否 |
["0.0.0.0", "10.2.XX.XX"] |
白名单组中的IP地址列表。如果选填了whiteIpGroup参数,则该参数必填。 |
- modifyMode为Cover时,如果ips为空,则删除该白名单组。如果groupName不在已有白名单组组名的列表中,则会新建一个白名单组。
- modifyMode为Delete时,删除后的ips至少需要保留一个IP地址。
- modifyMode为Append时,需要保证白名单组组名为已创建,否则会提示NotFound的错误。
返回数据
示例
请求示例
POST /openapi/instances/ es-cn-tl329rbpc0001****/private-network-white-ips HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json
{
"privateNetworkIpWhiteList": [
"192.168.XX.XX/25"
]
}
或
{
"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" : [ "192.168.XX.XX/25" ],
"enablePublic" : true,
"nodeSpec" : { },
"dataNode" : false,
"networkConfig" : {
"vpcId" : "vpc-bp1jy348ibzulk6hn****",
"vswitchId" : "vsw-bp1a0mifpletdd1da****",
"vsArea" : "cn-hangzhou-h",
"whiteIpGroupList" : [ {
"groupName" : "default",
"ips" : [ "192.168.XX.XX/25" ],
"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"
} ],
"type" : "vpc"
},
"createdAt" : "2021-07-21T01:29:38.510Z",
"updatedAt" : "2021-07-21T07:03:28.875Z",
"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" : [ "192.168.XX.XX/25" ],
"esIPBlacklist" : [ ],
"kibanaProtocol" : "HTTPS",
"kibanaIPWhitelist" : [ "::1", "110.0.XX.XX/9" ],
"kibanaPrivateIPWhitelist" : [ "192.168.XX.XX/24" ],
"publicIpWhitelist" : [ "::1", "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" : "6DEBE5EE-0368-4757-8F82-EF9C3972****"
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InstanceActivating | Instance is activating. | 实例目前处于生效中。 |
400 | InstanceNotFound | The instanceId provided does not exist. | 实例找不到,请核对实例状态。 |
访问错误中心查看更多错误码。