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 blocklist/allowlist. InstanceId
is required, while ForceRestart
is optional. Other parameters or parameter combinations and their meanings are as follows:
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
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common parameter. The value used for this API: UpdateInstance. |
Version | Yes | String | Common parameter. The value used for this API: 2018-04-16. |
Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
InstanceId | Yes | String | Instance ID |
InstanceName | No | String | Instance name, which can contain 1 to 50 English letters, Chinese characters, digits, dashes (-), or underscores (_) |
NodeNum | No | Integer | This parameter has been disused. Please use NodeInfoList Number of nodes (2-50) |
EsConfig | No | String | ES configuration item (JSON string) |
Password | No | String | Password of the default user 'elastic', which must contain 8 to 16 characters, including at least two of the following three types of characters: [a-z,A-Z], [0-9] and [-!@#$%&^*+=_:;,.?] |
EsAcl | No | EsAcl | Access control list |
DiskSize | No | Integer | This parameter has been disused. Please use NodeInfoList Disk size in GB |
NodeType | No | String | This parameter has been disused. Please use NodeInfoList Node specification |
MasterNodeNum | No | Integer | This parameter has been disused. Please use NodeInfoList Number of dedicated primary nodes (only 3 and 5 are supported) |
MasterNodeType | No | String | This parameter has been disused. Please use NodeInfoList Dedicated primary node specification |
MasterNodeDiskSize | No | Integer | This parameter has been disused. Please use NodeInfoList Dedicated primary node disk size in GB. This is 50 GB by default and currently cannot be customized |
ForceRestart | No | Boolean | Whether to force restart during configuration update |
CosBackup | No | CosBackup | Auto-backup to COS |
NodeInfoList.N | No | Array of NodeInfo | Node information list. You can pass in only the nodes to be updated and their corresponding specification information. Supported operations include: |
PublicAccess | No | String | Public network access status |
EsPublicAcl | No | EsPublicAcl | Public network ACL |
KibanaPublicAccess | No | String | Public network access status of Kibana |
KibanaPrivateAccess | No | String | Private network access status of Kibana |
BasicSecurityType | No | Integer | Enables or disables user authentication for ES Basic Edition v6.8 and above |
KibanaPrivatePort | No | Integer | Kibana private port |
ScaleType | No | Integer | 0: scaling in blue/green deployment mode without cluster restart (default); 1: scaling by unmounting disk with rolling cluster restart |
MultiZoneInfo.N | No | Array of ZoneDetail | Multi-AZ deployment |
SceneType | No | Integer | Scenario template type. -1: not enabled; 1: general; 2: log; 3: search |
KibanaConfig | No | String | Kibana configuration item (JSON string) |
Parameter Name | Type | Description |
---|---|---|
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to rename an ES cluster instance.
https://es.tencentcloudapi.com/?Action=UpdateInstance
&InstanceId=es-xxxxxx
&InstanceName=newName
&<Common request parameters>
{
"Response": {
"RequestId": "c96a110c-7493-452d-a99b-683d07xxxxxx"
}
}
This example shows you how to perform operations such as horizontally or vertically scaling an ES cluster instance or dedicated master node. NodeInfoList
must contain the information of all target nodes to be passed in.
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>
{
"Response": {
"RequestId": "6001962a-17c5-4604-a0af-0d4719xxxxxx"
}
}
This example shows you how to modify the configuration of an ES cluster instance.
https://es.tencentcloudapi.com/?Action=UpdateInstance
&InstanceId=es-xxxxxxxx
&EsConfig={"action.destructive_requires_name":"true"}
&<Common request parameters>
{
"Response": {
"RequestId": "e7c1bb22-e5f2-42f1-8a12-a97a6dxxxxxx"
}
}
This example shows you how to reset the Kibana password of an ES cluster instance.
https://es.tencentcloudapi.com/?Action=UpdateInstance
&InstanceId=es-xxxxxxxx
&Password=newPwd_123
&<Common request parameters>
{
"Response": {
"RequestId": "1b72089e-720f-4f95-a4ae-4da461xxxxxx"
}
}
This example shows you how to vertically scale the node specification (number of cores and memory size) and disk size of a cluster (currently only vertical scaling is supported).
https://es.tencentcloudapi.com/?Action=UpdateInstance
&InstanceId=es-xxxxxxxx
&NodeType=ES.S1.MEDIUM4
&DiskSize=150
&<Common request parameters>
{
"Response": {
"RequestId": "dd3f624d-9a72-4057-85cb-f5d32exxxxxx"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
FailedOperation.ClusterResourceLimitError | An error occurred with the cluster resource quota limit. |
FailedOperation.DiskCountParamError | Failed to query the number of disks of the node |
FailedOperation.ErrorClusterState | Incorrect cluster status |
FailedOperation.NoPayment | No credit card or PayPal account is linked to the current account. Unable to make a payment. |
InternalError | Internal error. |
InvalidParameter | Invalid parameter. |
ResourceInUse | Resource is in use. |
ResourceInsufficient | Insufficient resource. |
ResourceInsufficient.Balance | Insufficient account balance. |
ResourceInsufficient.Subnet | Insufficient number of remaining subnet IPs. |
UnsupportedOperation | Unsupported operation. |
Was this page helpful?