UpdateInstance

1. API Description

Domain name for API request: es.tencentcloudapi.com.

This API is used for operations such as modifying node specification, renaming an instance, modifying configuration, resetting password, and setting Kibana blacklist/whitelist. InstanceId is required, while ForceRestart is optional. Other parameters or parameter combinations and their meanings are as follows:

• InstanceName: renames an instance (only for instance identification)
• NodeInfoList: modifies node configuration (horizontally scaling nodes, vertically scaling nodes, adding master nodes, adding cold nodes, etc.)
• EsConfig: modifies cluster configuration
• Password: changes the password of the default user "elastic"
• EsAcl: modifies the ACL
• CosBackUp: sets auto-backup to COS for a cluster
  Only one of the parameters or parameter combinations above can be passed in at a time, while passing fewer or more ones will cause the request to fail.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: es.ap-shanghai-fsi.tencentcloudapi.com

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

3. Output Parameters

4. Example

Example1 Renaming an ES cluster instance

This example shows you how to rename the specified ES cluster instance.

Input Example

https://es.tencentcloudapi.com/?Action=UpdateInstance
&InstanceId=es-xxxxxx
&InstanceName=newName
&<common request parameters>

Output Example

{
  "Response": {
    "RequestId": "c96a110c-7493-452d-a99b-683d07xxxxxx"
  }
}

Example2 Modifying the node specification in an ES cluster

This example shows you how to perform operations such as horizontally or vertically scaling the specified ES cluster instance or dedicated master node, where NodeInfoList contains the information of all target nodes to be passed in.

Input Example

https://es.tencentcloudapi.com/?Action=UpdateInstance
&InstanceId=es-xxxxxx
&NodeInfoList.0.Type=hotData
&NodeInfoList.0.NodeNum=2
&NodeInfoList.0.NodeType=ES.S1.SMALL2
&NodeInfoList.0.DiskType=CLOUD_SSD
&NodeInfoList.0.DiskSize=100
&NodeInfoList.1.Type=dedicatedMaster
&NodeInfoList.1.NodeNum=3
&NodeInfoList.1.NodeType=ES.S1.SMALL2
&<common request parameters>

Output Example

{
  "Response": {
    "RequestId": "6001962a-17c5-4604-a0af-0d4719xxxxxx"
  }
}

Example3 Modifying ES cluster instance configuration

This example shows you how to modify the configuration of the specified ES cluster instance.

Input Example

https://es.tencentcloudapi.com/?Action=UpdateInstance
&InstanceId=es-xxxxxxxx
&EsConfig={"action.destructive_requires_name":"true"}
&<common request parameters>

Output Example

{
  "Response": {
    "RequestId": "e7c1bb22-e5f2-42f1-8a12-a97a6dxxxxxx"
  }
}

Example4 Resetting Kibana password

This example shows you how to reset the Kibana password of the specified ES cluster instance.

Input Example

https://es.tencentcloudapi.com/?Action=UpdateInstance
&InstanceId=es-xxxxxxxx
&Password=newPwd_123
&<common request parameters>

Output Example

{
  "Response": {
    "RequestId": "1b72089e-720f-4f95-a4ae-4da461xxxxxx"
  }
}

Example5 Vertically scaling an ES cluster

This example shows you how to vertically scale the node specification (number of cores and memory size) and disk size in a cluster (only vertical scaling is supported currently).

Input Example

https://es.tencentcloudapi.com/?Action=UpdateInstance
&InstanceId=es-xxxxxxxx
&NodeType=ES.S1.MEDIUM4
&DiskSize=150
&<common request parameters>

Output Example

{
  "Response": {
    "RequestId": "dd3f624d-9a72-4057-85cb-f5d32exxxxxx"
  }
}

Example6 Setting auto-backup to COS for ES

Input Example

https://es.tencentcloudapi.com/?Action=UpdateInstance
&InstanceId=es-xxxxxxxx
&CosBackup.IsAutoBackup=true
&CosBackup.BackupTime=23:00
&<common request parameters>

Output Example

{
  "Response": {
    "RequestId": "dd3f624d-9a72-4057-85cb-f5d32exxxxxx"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

• API 3.0 Explorer

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for NodeJS
• Tencent Cloud SDK 3.0 for .NET

Command Line Interface

• Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.