UpdateInstanceSettings - Elasticsearch - Alibaba Cloud ドキュメントセンター

指定された Elasticsearch インスタンスの YML パラメーター構成を変更します。

以下の点にご注意ください。

インスタンスが activating、invalid、または inactive 状態の場合、構成を更新することはできません。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK 用の操作のサンプルコードを動的に生成します。

リクエストヘッダー

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

リクエスト構文

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

リクエストパラメーター

パラメーター	タイプ	位置	必須	例	説明
InstanceId	String	Path	はい	es-cn-nif1q9o8r0008****	ApsaraMQ for RocketMQ インスタンスの ID。
clientToken	String	Query	いいえ	5A2CFF0E-5718-45B5-9D4D-70B3FF****	リクエストのべき等性を確保するために使用されます。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。
	String	Body	いいえ	{ "esConfig": { "thread_pool.write.queue_size": 500 } }	更新する YML パラメーターの値を指定します。

リクエスト本文

更新する YML パラメーターの値を指定するには、リクエスト本文パラメーターに esConfig パラメーターも入力する必要があります。 YML パラメーターの詳細については、「YML パラメーターを構成する」をご参照ください。

ドキュメント書き込みキューのサイズを調整します。次の例は、Alibaba Cloud Elasticsearch 6.x、7.x、および 8.x に適用されます。

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

レスポンスパラメーター

パラメーター	タイプ	例	説明
RequestId	String	BB1C321A-211C-4FD7-BD8B-7F2FABE2****	リクエスト ID。

返されるデータには、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****"
}

エラーコード

エラーコードのリストについては、「サービスエラーコード」をご参照ください。