1. API Description

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

Perform operations on the cluster, such as node specification change, instance name modification, configuration modification, password resetting, and Kibana blocklist/allowlist addition. InstanceId is a required parameter, while ForceRestart is optional. The remaining parameter combinations and their meanings are as follows:

• InstanceName: Modify the instance name (only used to identify the instance)
  -NodeInfoList: Modify node configuration (horizontally scale nodes, vertically scale nodes, add primary nodes, add cold nodes, etc.)
  -EsConfig: modify cluster configuration
  -Password: Modify the password of the default user elastic
  -EsAcl: Modify an ACL
  -CosBackUp: Set cluster COS auto backup information
  Only one of the above parameters can be passed. Passing more or fewer will cause request failure.

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

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 Vertically Scale an ES Cluster

Used to perform shard scaling on the node specification (cores, memory size) and disk capacity of a cluster (currently only support vertical scale-out).

Input Example

POST / HTTP/1.1
Host: es.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateInstance
<Common request parameters>

{
    "InstanceId": "es-xxxxxxxx",
    "DiskSize": 150,
    "NodeType": "ES.S1.MEDIUM4"
}

Output Example

{
    "Response": {
        "RequestId": "1",
        "DealName": "1"
    }
}

Example2 Node specification change for ES cluster

This is used to horizontally scale, vertically scale, add dedicated master nodes, horizontally scale dedicated master nodes, and vertically scale dedicated master nodes for a specified ES cluster instance. NodeInfoList should transmit the information of all target nodes.

Input Example

POST / HTTP/1.1
Host: es.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateInstance
<Common request parameters>

{
    "InstanceId": "es-xxxxxx",
    "NodeInfoList": [
        {
            "NodeType": "ES.S1.SMALL2",
            "NodeNum": 3,
            "Type": "dedicatedMaster"
        },
        {
            "DiskSize": 100,
            "NodeType": "ES.S1.SMALL2",
            "NodeNum": 2,
            "Type": "hotData",
            "DiskType": "CLOUD_SSD"
        }
    ]
}

Output Example

{
    "Response": {
        "RequestId": "1",
        "DealName": "1"
    }
}

Example3 Modifying the Name of an ES Cluster Instance

Used to modify the name of a specified ES cluster instance.

Input Example

POST / HTTP/1.1
Host: es.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateInstance
<Common request parameters>

{
    "InstanceId": "es-xxxxxx",
    "InstanceName": "newName"
}

Output Example

{
    "Response": {
        "RequestId": "1",
        "DealName": "1"
    }
}

Example4 Modifying ES Cluster Instance Configuration

Used to make modifications to the configuration of a specified ES cluster instance.

Input Example

POST / HTTP/1.1
Host: es.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateInstance
<Common request parameters>

{
    "InstanceId": "es-xxxxxxxx",
    "EsConfig": "{\"action.destructive_requires_name\":\"true\"}"
}

Output Example

{
    "Response": {
        "RequestId": "1",
        "DealName": "1"
    }
}

Example5 Reset the Kibana password

Reset the Kibana password of a specified ES cluster instance.

Input Example

POST / HTTP/1.1
Host: es.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateInstance
<Common request parameters>

{
    "InstanceId": "es-xxxxxxxx",
    "Password": "newPwd_123"
}

Output Example

{
    "Response": {
        "RequestId": "1",
        "DealName": "1"
    }
}

5. Developer Resources

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 Node.js
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++

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.