UpdateInstance

Last updated: 2020-07-31 10:14:09

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 blocklist/allowlist. 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 primary 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

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

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.

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 Configuration item (JSON string). Only the following items are supported currently:
  • action.destructive_requires_name
  • indices.fielddata.cache.size
  • indices.query.bool.max_clause_count
  • 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
  • ES.S1.SMALL2: 1-core 2 GB
  • ES.S1.MEDIUM4: 2-core 4 GB
  • ES.S1.MEDIUM8: 2-core 8 GB
  • ES.S1.LARGE16: 4-core 16 GB
  • ES.S1.2XLARGE32: 8-core 32 GB
  • ES.S1.4XLARGE32: 16-core 32 GB
  • ES.S1.4XLARGE64: 16-core 64 GB
  • 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
  • ES.S1.SMALL2: 1-core 2 GB
  • ES.S1.MEDIUM4: 2-core 4 GB
  • ES.S1.MEDIUM8: 2-core 8 GB
  • ES.S1.LARGE16: 4-core 16 GB
  • ES.S1.2XLARGE32: 8-core 32 GB
  • ES.S1.4XLARGE32: 16-core 32 GB
  • ES.S1.4XLARGE64: 16-core 64 GB
  • 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
  • true: Yes
  • false: No
  • This needs to be set only for EsConfig. Default value: false
    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:
  • modifying the number of nodes in the same type
  • modifying the specification and disk size of nodes in the same type
  • adding a node type (you must also specify the node type, quantity, specification, disk, etc.)
  • The above operations can only be performed one at a time, and the disk type cannot be modified
    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

    3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 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"
      }
    }

    Example2 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"
      }
    }

    Example3 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"
      }
    }

    Example4 Setting auto-backup to COS for ES

    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
    &CosBackup.IsAutoBackup=true
    &CosBackup.BackupTime=23:00
    &<common request parameters>

    Output Example

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

    Example5 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"
      }
    }

    Example6 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"
      }
    }

    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.

    SDK

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

    Command Line Interface

    6. Error Code

    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.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?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help