調(diào)用UpdatePublicNetwork，開(kāi)啟或關(guān)閉指定Elasticsearch實(shí)例的公網(wǎng)地址。

調(diào)用該接口時(shí)，請(qǐng)注意：

當(dāng)實(shí)例狀態(tài)為生效中（activating）、失效（invalid）和凍結(jié)（inactive）時(shí)，無(wú)法更新信息。

調(diào)試

您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。

請(qǐng)求頭

該接口使用公共請(qǐng)求頭，無(wú)特殊請(qǐng)求頭。請(qǐng)參見(jiàn)公共請(qǐng)求參數(shù)文檔。

請(qǐng)求語(yǔ)法

PATCH|POST /openapi/instances/[InstanceId]/public-network HTTP/1.1

請(qǐng)求參數(shù)

名稱 類型 位置 是否必選 示例值 描述
InstanceId String Path 是 es-cn-nif1q9o8r0008****

實(shí)例ID。
clientToken String Query 否 5A2CFF0E-5718-45B5-9D4D-70B3FF****

用于保證請(qǐng)求的冪等性。由客戶端生成該參數(shù)值，要保證在不同請(qǐng)求間唯一，最大不超過(guò)64個(gè)ASCII字符。

RequestBody

您還可以在RequestBody中填入enablePublic參數(shù)（可選，默認(rèn)為false）。Boolean類型，為true時(shí)表示開(kāi)啟公網(wǎng)地址訪問(wèn)，為false時(shí)表示關(guān)閉公網(wǎng)地址訪問(wèn)，示例如下。 


{
  "enablePublic": true
}

返回?cái)?shù)據(jù)

名稱 類型 示例值 描述
RequestId String 2A88ECA1-D827-4581-AD39-05149586****

請(qǐng)求ID。
Result Struct

返回結(jié)果。
enablePublic Boolean false

公網(wǎng)地址開(kāi)關(guān)狀態(tài)。
說(shuō)明 下文返回示例中，本文只保證包含返回?cái)?shù)據(jù)列表中的參數(shù)，而未提到的參數(shù)僅供參考，參數(shù)說(shuō)明請(qǐng)參見(jiàn)ListInstance。程序中不能強(qiáng)制依賴獲取這些參數(shù)。

示例

請(qǐng)求示例

PATCH /openapi/instances/es-cn-nif1q9o8r0008****/public-network HTTP/1.1
公共請(qǐng)求頭
{
  "enablePublic": true
}

正常返回示例

JSON格式 

{
	"Result": {
		"instanceId": "es-cn-nif1q9o8r0008****",
		"version": "6.7.0_with_X-Pack",
		"description": "es-cn-nif1q9o8r0008****",
		"nodeAmount": 4,
		"paymentType": "postpaid",
		"status": "active",
		"privateNetworkIpWhiteList": [
			"0.0.0.0/0"
		],
		"enablePublic": true,
		"nodeSpec": {
			"spec": "elasticsearch.n4.small",
			"disk": 20,
			"diskType": "cloud_ssd",
			"diskEncryption": false
		},
		"networkConfig": {
			"vpcId": "vpc-bp16k1dvzxtmagcva****",
			"vswitchId": "vsw-bp1k4ec6s7sjdbudw****",
			"vsArea": "cn-hangzhou-i",
			"type": "vpc"
		},
		"createdAt": "2020-07-07T04:05:16.791Z",
		"updatedAt": "2020-07-07T10:15:14.498Z",
		"commodityCode": "elasticsearch",
		"extendConfigs": [
			{
				"configType": "usageScenario",
				"value": "general"
			},
			{
				"configType": "maintainTime",
				"maintainStartTime": "02:00Z",
				"maintainEndTime": "06:00Z"
			},
			{
				"configType": "aliVersion",
				"aliVersion": "ali1.2.0"
			}
		],
		"endTime": 4749811200000,
		"clusterTasks": [
			{
				"type": "MigrateData",
				"progress": 100,
				"detail": {},
				"status": "FINISHED",
				"canCancelable": false,
				"interruptible": false,
				"subTasks": [
					{
						"type": "FindShrinkNodeAction",
						"progress": 100,
						"detail": {},
						"status": "FINISHED",
						"canCancelable": false,
						"interruptible": false,
						"subTasks": []
					},
					{
						"type": "MigrateDataAction",
						"progress": 100,
						"detail": {
							"doneMigrateNodeIps": [
								"172.16.**.**"
							],
							"allMigrateNodeIps": [
								"172.16.**.**"
							]
						},
						"status": "FINISHED",
						"canCancelable": false,
						"interruptible": false,
						"subTasks": []
					}
				]
			}
		],
		"vpcInstanceId": "es-cn-nif1q9o8r0008****-worker",
		"resourceGroupId": "rg-acfm2h5vbzdokea",
		"zoneCount": 1,
		"protocol": "HTTP",
		"zoneInfos": [
			{
				"zoneId": "cn-hangzhou-i",
				"status": "NORMAL"
			}
		],
		"instanceType": "elasticsearch",
		"inited": true,
		"tags": [],
		"domain": "es-cn-nif1q9o8r0008****.elasticsearch.aliyuncs.com",
		"port": 9200,
		"esVersion": "6.7.0_with_X-Pack",
		"esConfig": {
			"thread_pool.bulk.queue_size": "500"
		},
		"esIPWhitelist": [
			"0.0.0.0/0"
		],
		"esIPBlacklist": [],
		"kibanaIPWhitelist": [
			"0.0.0.0/0",
			"::/0"
		],
		"kibanaPrivateIPWhitelist": [],
		"publicIpWhitelist": [],
		"kibanaDomain": "es-cn-nif1q9o8r0008****.kibana.elasticsearch.aliyuncs.com",
		"kibanaPort": 5601,
		"haveKibana": true,
		"instanceCategory": "x-pack",
		"dedicateMaster": false,
		"advancedDedicateMaster": false,
		"masterConfiguration": {},
		"haveClientNode": false,
		"warmNode": false,
		"warmNodeConfiguration": {},
		"clientNodeConfiguration": {},
		"kibanaConfiguration": {
			"spec": "elasticsearch.n4.small",
			"amount": 1,
			"disk": 0
		},
		"dictList": [
			{
				"name": "SYSTEM_MAIN.dic",
				"fileSize": 2782602,
				"sourceType": "ORIGIN",
				"type": "MAIN"
			},
			{
				"name": "SYSTEM_STOPWORD.dic",
				"fileSize": 132,
				"sourceType": "ORIGIN",
				"type": "STOP"
			}
		],
		"synonymsDicts": [
			{
				"name": "dict_0.txt",
				"fileSize": 220,
				"sourceType": "ORIGIN",
				"type": "SYNONYMS"
			}
		],
		"ikHotDicts": [],
		"aliwsDicts": [],
		"haveGrafana": false,
		"haveCerebro": false,
		"enableKibanaPublicNetwork": true,
		"enableKibanaPrivateNetwork": false,
		"advancedSetting": {
			"gcName": "CMS"
		}
	},
	"RequestId": "17632473-6A3B-4D0C-A603-A56D5743****"
}

錯(cuò)誤碼

HttpCode 錯(cuò)誤碼 錯(cuò)誤信息 描述
400 InstanceNotFound The instanceId provided does not exist. 實(shí)例找不到，請(qǐng)核對(duì)實(shí)例狀態(tài)。

訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。