tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

UpdateInstance

Last updated: 2023-02-13 10:21:11

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.

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 Params. The value used for this API: UpdateInstance.
Version Yes String Common Params. The value used for this API: 2018-04-16.
Region Yes String Common Params. 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 The policy for visual component (Kibana and Cerebro) access over public network.
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 The status of ES cluster access over public network.
    OPEN: Enabled.
    CLOSE: Disabled.
    EsPublicAcl No EsPublicAcl Public network ACL
    KibanaPublicAccess No String The status of Kibana access over public network.
    OPEN: Enabled.
    CLOSE: Disabled.
    KibanaPrivateAccess No String The status of Kibana access over private network.
    OPEN: Enabled.
    CLOSE: Disabled.
    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)
    WebNodeTypeInfo No WebNodeTypeInfo Visual node configuration
    SwitchPrivateLink No String Whether to switch to the new network architecture
    EnableCerebro No Boolean Whether to enable Cerebro
    CerebroPublicAccess No String The status of Cerebro access over public network.
    OPEN: Enabled.
    CLOSE: Disabled.
    CerebroPrivateAccess No String The status of Cerebro access over private network.
    OPEN: Enabled.
    CLOSE: Disabled.
    EsConfigSet No EsConfigSetInfo Added or modified configuration set information
    OperationDuration No OperationDurationUpdated The maintenance time slot
    KibanaAlteringPublicAccess No String Whether to enable the option for sending alerting messages over the public network.
    OPEN: Enabled.
    CLOSE: Disabled.

    3. Output Parameters

    Parameter Name Type Description
    DealName String Order ID
    Note: This field may return null, indicating that no valid value was found.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Renaming an ES cluster instance

    This example shows you how to rename an ES cluster instance.

    Input Example

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

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

    Output Example

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

    Example2 Modifying the node specification of an ES cluster

    This example shows you how to scale out/in or scale up/down an ES cluster instance or a dedicated master node, or to add a dedicated master node. NodeInfoList must contain the information of all target nodes to be passed in.

    Input Example

    POST / HTTP/1.1
Host: es.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": "xx",
        "DealName": "xx"
    }
}

    Example3 Modifying the configuration of an ES cluster instance

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

    Input Example

    POST / HTTP/1.1
Host: es.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": "xx",
        "DealName": "xx"
    }
}

    Example4 Resetting the Kibana password

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

    Input Example

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

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

    Output Example

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

    Example5 Scaling up/down an ES cluster

    This example shows you how to scale up/down a cluster in terms of its node spec (number of cores, memory size) and disk size.

    Input Example

    POST / HTTP/1.1
Host: es.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": "xx",
        "DealName": "xx"
    }
}

    5. Developer Resources

    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.DiskCountParamError Failed to query the number of disks of the node
    FailedOperation.ErrorClusterState Incorrect cluster status
    FailedOperation.ErrorClusterStateUnhealth The cluster is unhealthy.
    FailedOperation.NoPayment No credit card or PayPal account is linked to the current account. Unable to make a payment.
    FailedOperation.UnsupportResetNodeTypeAndScaleoutDisk Cannot increase the number of disks during rolling restart of scaled-out compute resources.
    FailedOperation.UnsupportResetScaledownAndModifyDisk The disk capacity can’t be modified during rolling restart of scaled-in compute resources.
    FailedOperation.UnsupportReverseRegulationNodeTypeAndDisk Cannot adjust the node configuration and disk capacity reversely.
    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.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy