Atualiza as configurações de parâmetros no arquivo YML de um cluster Elasticsearch.
Ao chamar esta operação, observe os seguintes pontos:
Não é possível atualizar as configurações de um cluster Elasticsearch nos estados activating, invalid ou inactive.
Depuração
Cabeçalhos da requisição
Esta operação não possui cabeçalhos específicos e utiliza apenas cabeçalhos comuns. Para mais informações, consulte a seção "Common request headers" do tópico "Common parameters".
Sintaxe da requisição
PATCH|POST /openapi/instances/{InstanceId}/instance-settings HTTP/1.1Parâmetros da requisição
|
Parameter |
Type |
Position |
Required |
Example |
Description |
| InstanceId | String | Path | Yes | es-cn-nif1q9o8r0008**** |
ID do cluster. |
| updateStrategy | String | Query | No | normal |
Política de atualização do cluster, como modo de atualização de índices, upgrade de cluster ou implantação de serviço. Valores válidos:
|
| clientToken | String | Query | No | 5A2CFF0E-5718-45B5-9D4D-70B3FF**** |
Token de cliente usado para garantir a idempotência da requisição. Gere o token com o cliente e assegure que seja único entre requisições distintas. O token deve conter apenas caracteres ASCII e ter no máximo 64 caracteres. |
| String | Body | No | { "esConfig": { "thread_pool.write.queue_size": 500 } } |
Configuração de parâmetro a ser atualizada. |
RequestBody
Configure o parâmetro esConfig no RequestBody para especificar o novo valor do parâmetro desejado. Para obter mais detalhes sobre os parâmetros em um arquivo YML, consulte Configurar o arquivo YML.
O código a seguir demonstra como ajustar o tamanho da fila de gravação de documentos para um cluster Elasticsearch V6.X, V7.X ou V8.X.
{
"esConfig": {
"thread_pool.write.queue_size": 500
}
}
Parâmetros de resposta
|
Parameter |
Type |
Example |
Description |
|
RequestId |
String |
BB1C321A-211C-4FD7-BD8B-7F2FABE2**** |
ID da requisição. |
Os parâmetros de resposta também incluem Result. Para mais informações, consulte ListInstance.
Exemplos
Exemplos de requisições
PATCH /openapi/instances/es-cn-nif1q9o8r0008****/instance-settings HTTP/1.1
Common request parameters
{
"esConfig": {
"thread_pool.bulk.queue_size": 500
}
}Exemplos de respostas de sucesso
Formato 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****"
}Códigos de erro
Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.