Elasticsearch:UpdateWhiteIps

使用上の注意

• インスタンスが Activating、Invalid、または Inactive 状態の場合、情報は更新できません。
• ホワイトリストは、IP アドレス ホワイトリストと IP アドレス ホワイトリストグループの 2 つの方法で更新できます。 2 つの方法は同時に使用できません。 InstanceId と clientToken に加えて、2 つのメソッドは以下のように異なるパラメーターをサポートしています。
  • IP アドレス ホワイトリスト: esIPWhitelist
  • IP アドレス ホワイトリストグループ: modifyMode と whiteIpGroup
• パブリックネットワークアクセス ホワイトリストは、プライベート IP アドレスの構成をサポートしていません。 プライベートネットワークアクセス ホワイトリストは、パブリック IP アドレスの構成をサポートしていません。

リクエストヘッダー

この操作では、共通のリクエストヘッダーのみを使用します。 詳細については、共通リクエストパラメーターのドキュメントを参照してください。

リクエスト構文

PATCHPOST /openapi/instances/{InstanceId}/white-ips HTTP/1.1

リクエストパラメーター

レスポンスパラメーター

例

リクエストの例

PATCH /openapi/instances/es-cn-npk2154oi000b****/white-ips HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json
{
    "esIPWhitelist": [
        "110.0.XX.XX/8"
    ]
}
or
{
    "whiteIpGroup": {
        "groupName": "test_group_name", 
        "ips": [
            "0.0.0.0", 
            "10.2.XX.XX"
        ],
        "whiteIpType" : "PRIVATE_ES"
    }
}

成功レスポンスの例

JSON 形式

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

{
  "Result" : {
    "instanceId" : "es-cn-xxx",
    "domain" : "es-cn-xxx.elasticsearch.aliyuncs.com",
    "description" : "aliyunes_name_test",
    "nodeAmount" : 3,
    "paymentType" : "postpaid",
    "status" : "active",
    "port" : 9200,
    "esVersion" : "5.5.3_with_X-Pack",
    "esConfig" : {
      "action.destructive_requires_name" : "true",
      "xpack.security.audit.outputs" : "index",
      "xpack.watcher.enabled" : "false",
      "xpack.security.audit.enabled" : "true",
      "action.auto_create_index" : "+.*,-*"
    },
    "esIPWhitelist" : [ "192.168.xx.xx/24" ],
    "esIPBlacklist" : [ ],
    "privateNetworkIpWhiteList" : [ "192.168.xx.xx/24" ],
    "kibanaIPWhitelist" : [ "0.0.0.0/0", "::/0" ],
    "publicIpWhitelist" : [ ],
    "kibanaDomain" : "es-cn-xxx.kibana.elasticsearch.aliyuncs.com",
    "kibanaPort" : 5601,
    "enablePublic" : false,
    "nodeSpec" : {
      "spec" : "elasticsearch.n4.small",
      "disk" : 20,
      "diskType" : "cloud_ssd"
    },
    "networkConfig" : {
      "vpcId" : "vpc-bp1uag5jj38ccmwn1****",
      "vswitchId" : "vsw-bp1knt7m4cyn5k3a7****",
      "vsArea" : "cn-hangzhou-b",
      "type" : "vpc",
      "whiteIpGroupList" : [ {
        "groupName" : "default",
        "ips" : [ "0.0.0.0", "10.2.xx.xx" ]
      }, {
        "groupName" : "test_group_name",
        "ips" : [ "10.2.xx.xx" ]
      } ]
    },
    "createdAt" : "2019-01-17T09:22:45.888Z",
    "updatedAt" : "2019-03-15T13:21:20.728Z",
    "inited" : true,
    "dedicateMaster" : false,
    "advancedDedicateMaster" : false,
    "masterConfiguration" : { },
    "haveClientNode" : false,
    "warmNode" : false,
    "warmNodeConfiguration" : { },
    "clientNodeConfiguration" : { },
    "kibanaConfiguration" : {
      "spec" : "elasticsearch.n4.small",
      "amount" : 1,
      "disk" : 0
    },
    "commodityCode" : "elasticsearch",
    "endTime" : 4703414400000,
    "dictList" : [ {
      "name" : "SYSTEM_MAIN",
      "fileSize" : 3058510,
      "type" : "MAIN",
      "sourceType" : "ORIGIN"
    }, {
      "name" : "SYSTEM_STOPWORD",
      "fileSize" : 164,
      "type" : "STOP",
      "sourceType" : "ORIGIN"
    } ],
    "synonymsDicts" : [ ],
    "ikHotDicts" : [ {
      "name" : "test",
      "fileSize" : 8,
      "type" : "MAIN",
      "sourceType" : "ORIGIN"
    } ],
    "clusterTasks" : [ ],
    "vpcInstanceId" : "es-cn-xxx-worker"
  },
  "RequestId" : "C82758DD-282F-4D48-934F-92170A3388FA"
}

エラーコード

エラーコードのリストについては、API エラーセンターをご覧ください。