調用該接口時，請注意：

實例狀態為生效中（activating）、失效（invalid）和凍結（inactive）時，無法更新配置。

請求頭

該接口使用公共請求頭，無特殊請求頭。請參見公共請求參數文檔。

請求語法

PATCH|POST /openapi/instances/{InstanceId}/instance-settings HTTP/1.1

請求參數

RequestBody

RequestBody中還需填入esConfig參數，用來指定待更新的YML參數的值。關于YML參數的更多信息，請參見配置YML參數。

調整文檔寫入隊列大小，以下示例適用于阿里云Elasticsearch 6.x、7.x及8.x版本。

{
    "esConfig": {
        "thread_pool.write.queue_size": 500
    }
}

返回數據

返回數據中還包括Result參數，詳情請參見ListInstance。

示例

請求示例

PATCH /openapi/instances/es-cn-nif1q9o8r0008****/instance-settings HTTP/1.1
公共請求頭
{
    "esConfig": {
        "thread_pool.bulk.queue_size": 500
    }
}

正常返回示例

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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" : false,
    "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-07T07:09:51.268Z",
    "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-acfm2h5vbzd****",
    "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",
      "xpack.security.authc.realms.native.type" : "native",
      "xpack.security.authc.reserved_realm.enabled" : "false",
      "xpack.security.transport.ssl.truststore.path" : "168520994880****.p12",
      "xpack.security.authc.realms.native.order" : "1",
      "xpack.license.self_generated.type" : "trial",
      "xpack.security.authc.realms.file.order" : "0",
      "xpack.security.authc.realms.file.type" : "file",
      "xpack.security.enabled" : "true",
      "bootstrap.memory_lock" : "true",
      "xpack.monitoring.collection.enabled" : "true",
      "xpack.security.transport.ssl.keystore.path" : "168520994880****.p12",
      "xpack.security.transport.ssl.verification_mode" : "certificate",
      "xpack.security.transport.ssl.enabled" : "true"
    },
    "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" : [ ],
    "ikHotDicts" : [ ],
    "aliwsDicts" : [ ],
    "haveGrafana" : false,
    "haveCerebro" : false,
    "enableKibanaPublicNetwork" : true,
    "enableKibanaPrivateNetwork" : false,
    "advancedSetting" : {
      "gcName" : "CMS"
    }
  },
  "RequestId" : "C1FA70F8-B84E-4D89-B31A-BCD1E476****"
}

錯誤碼

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