UpdatePublicNetwork を呼び出して、指定した Elasticsearch インスタンスのパブリックネットワークアドレスを開いたり閉じたりします。
この操作を呼び出すときは、次の点に注意してください。
インスタンスが activating、invalid、または inactive 状態の場合、その構成は更新できません。
デバッグ
リクエストヘッダー
この操作では、共通のリクエストパラメーターのみを使用します。 詳細については、「共通パラメーター」をご参照ください。
リクエスト構文
PATCH|POST /openapi/instances/[InstanceId]/public-network HTTPS|HTTPリクエストパラメーター
| パラメーター | タイプ | 必須 | 例 | 説明 |
| InstanceId | String | はい | es-cn-nif1q9o8r0008**** | インスタンス ID。 |
| clientToken | String | いいえ | 5A2CFF0E-5718-45B5-9D4D-70B3FF**** | リクエストの冪等性を保証するためにクライアントによって生成された一意のトークン。 クライアントを使用して値を生成できますが、異なるリクエスト間で一意であることを確認する必要があります。 トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。 |
RequestBody
RequestBody に enablePublic パラメーターを入力することもできます（オプション）。デフォルト値は false です。ブール型。値が true の場合は、パブリックエンドポイントへのアクセスが有効になっていることを示します。値が false の場合は、パブリックエンドポイントへのアクセスが無効になっていることを示します。例：
また、RequestBody に enablePublic パラメーターを入力することもできます（オプション。デフォルトは false）。ブール値型。true はパブリック ネットワーク アドレス アクセスが有効であることを意味し、false は無効であることを意味します。例：
{
"enablePublic": true
}
レスポンスパラメーター
| パラメーター | タイプ | 例 | 説明 |
| RequestId | String | 2A88ECA1-D827-4581-AD39-05149586**** | リクエスト ID。 |
| Result | Struct | 戻り結果。 | |
| enablePublic | Boolean | false | パブリックネットワークアクセススイッチの状態。 |
例
リクエストの例
PATCH /openapi/instances/es-cn-nif1q9o8r0008****/public-network HTTP/1.1
共通リクエストパラメーター
{
"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****"
}エラーコード
| HttpCode | エラーコード | エラーメッセージ | 説明 |
| 400 | InstanceNotFound | 指定された instanceId は存在しません。 | 指定されたインスタンスが見つからないため返されるエラーメッセージ。 インスタンスの状態を確認してください。 |
エラーコードのリストについては、「API エラーセンター」をご参照ください。