ModifyWhiteIps - Elasticsearch

注意事項

執行個體狀態為生效中（activating）、失效（invalid）和凍結（inactive），無法更新資訊。
您可以通過兩種方式更新白名單：IP白名單列表和IP白名單組。兩種方式不能同時使用，且除了InstanceId和clientToken外，兩種方式支援配置的參數也不同，具體如下：
- IP白名單列表：whiteIpList、nodeType、networkType
- IP白名單組：modifyMode、whiteIpGroup
公網訪問白名單不支援配置私網IP地址，私網訪問白名單不支援配置公網IP地址。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

要求標頭

該介面使用公用要求標頭，無特殊要求標頭。請參見公用請求參數文檔。

請求文法

PATCH|POST /openapi/instances/{InstanceId}/actions/modify-white-ips HTTP/1.1

請求參數

名稱	類型	位置	是否必選	樣本值	描述
InstanceId	String	Path	是	es-cn-0pp1jxvcl000z****	執行個體ID。
clientToken	String	Query	否	5A2CFF0E-5718-45B5-9D4D-70B3FF****	用於保證請求的等冪性。由用戶端產生該參數值，要保證在不同請求間唯一，最大不超過64個ascii字元。
	Object	Body	否		請求體參數。
nodeType	String	Body	否	WORKER	節點類型，如果選填了whiteIpList參數，則該參數必填。可選值： WORKER：Elasticsearch叢集 KIBANA：Kibana叢集
networkType	String	Body	否	PUBLIC	網路類型，如果選填了whiteIpList參數，則該參數必填。可選值： PRIVATE：私網 PUBLIC：公網
modifyMode	String	Body	否	Cover	修改方式，可選值： Cover（預設）：使用ips參數的值覆蓋原IP白名單。 Append：在原IP白名單中增加ips參數中輸入的IP地址。 Delete：在原IP白名單中刪除ips參數中輸入的IP地址，至少需要保留一個IP地址。
whiteIpList	Array of String	Body	否	192.168.xx.xx	IP地址白名單列表。whiteIpGroup為空白時可用，該參數值會更新Default白名單分組中的IP白名單配置。重要不支援同時配置whiteIpList和whiteIpGroup。
whiteIpGroup	Object	Body	否		以白名單組方式更新執行個體白名單配置，僅支援更新一個白名單組。重要不支援同時配置whiteIpList和whiteIpGroup。
groupName	String	Body	否	test_group	白名單組的組名。如果選填了whiteIpGroup參數，則該參數必填。
ips	Array of String	Body	否	192.168.xx.xx	白名單組中的IP地址清單。如果選填了whiteIpGroup參數，則該參數必填。
whiteIpType	String	Body	否	PRIVATE_ES	IP白名單的類型，可選值： PRIVATE_KIBANA：Kibana私網訪問白名單 PRIVATE_ES：Elasticsearch私網訪問白名單 PUBLIC_ES：Elasticsearch公網訪問白名單 PUBLIC_KIBANA：Kibana公網訪問白名單

重要白名單組的增加和刪除是由modifyMode為Cover的調用來實現的，Delete和Append無法實現白名單組粒度的增刪，只能修改白名單組中的IP地址清單。具體說明如下：

modifyMode為Cover時，如果ips為空白，則刪除該白名單組。如果groupName不在已有白名單組組名的列表中，則會建立一個白名單組。
modifyMode為Delete時，刪除後的ips至少需要保留一個IP地址。
modifyMode為Append時，需要保證白名單組組名為已建立，否則會提示NotFound的錯誤。

返回資料

名稱

類型

樣本值

描述

Result

Boolean

true

返回結果：

true：白名單更新成功
false：白名單更新失敗

RequestId

String

5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1DERFG

請求ID。

樣本

請求樣本

PATCH /openapi/instances/es-cn-0pp1jxvcl000z****/actions/modify-white-ips HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json
{
    "nodeType" : "WORKER",
    "networkType" : "PUBLIC",
    "whiteIpList": [
        "110.0.XX.XX/8"
    ]
}
或
{
    "modifyMode": "cover",
    "whiteIpGroup": {
        "groupName": "test_group_name", 
        "ips": [
            "0.0.0.0", 
            "10.2.XX.XX"
        ],
        "whiteIpType" : "PRIVATE_ES"
    }
}

正常返回樣本

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyWhiteIpsResponse>
    <Result>true</Result>
    <RequestId>5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1DERFG</RequestId>
</ModifyWhiteIpsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Result" : true,
  "RequestId" : "5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1DERFG"
}

錯誤碼

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