tencent cloud

APIs

UpgradeLicense

Download
Focus Mode
Font Size
Last updated: 2026-10-13 13:26:36

1. API Description

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

Upgrade ES commercial features

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: UpgradeLicense.
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
LicenseType Yes String License type
  • oss: open source edition
  • basic: basic version
  • platinum: platinum version
  • Default value: platinum
    AutoVoucher No Integer Indicates whether to use vouchers automatically
  • 0: Do not use automatically.
  • 1: Use automatically.
  • Default value: 0.
    VoucherIds.N No Array of String Voucher ID list. Only one voucher can be specified.
    BasicSecurityType No Integer Whether xpack security authentication is enabled for basic version 6.8 (and above versions)
  • 1: not enabled
  • 2: enabled
  • If no parameter is passed, the original status is maintained by default. When passing a parameter, note that it can only change from not enabled to enabled, and cannot change from enabled to not enabled
  • ForceRestart No Boolean Whether to force restart
  • true: force restart
  • false: do not force restart
  • Default value: false

    3. Output Parameters

    Parameter Name Type Description
    DealName String Order ID
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Upgrade ES Commercial Features

    Upgrade ES commercial features

    Input Example

    POST / HTTP/1.1
    Host: es.intl.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: UpgradeLicense
    <Common request parameters>
    
    {
        "InstanceId": "es-xxxxxxxx",
        "LicenseType": "platinum"
    }

    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.

    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.EsDictionaryInfoError Manipulation is not allowed due to EsDictionaryInfo error.
    FailedOperation.NoPayment The account is not bound to a credit card or paypal and cannot pay.
    FailedOperation.NotAuthenticated REAL_NAME_CHECK_FAIL.
    InternalError Internal error.
    InvalidParameter Parameter error.
    InvalidParameter.InvalidAppId The APPID value does not match the expectation.
    InvalidParameter.InvalidAutoVoucher The value of whether to automatically use a voucher AutoVoucher does not match the expectation.
    InvalidParameter.InvalidCosBackupInfo cos auto backup information does not meet expectations.
    InvalidParameter.InvalidDiskCount The value of the node disk count DiskCount does not match the expectation.
    InvalidParameter.InvalidDiskSize The value of the node disk capacity DiskSize does not match the expectation.
    InvalidParameter.InvalidDiskType The value of the node disk type DiskType does not match the expectation.
    InvalidParameter.InvalidEsVersion The instance version EsVersion does not match the expectation.
    InvalidParameter.InvalidInstanceId Invalid InstanceId. No corresponding resources were found.
    InvalidParameter.InvalidKibanaPrivatePort The value of the Kibana private network access port does not match the expectation.
    InvalidParameter.InvalidNodeNum The value of NodeNum does not match the expected value.
    InvalidParameter.InvalidNodeType The value of NodeType does not match the expected value.
    InvalidParameter.InvalidOpType The value of the operation type OpType does not match the expected value.
    InvalidParameter.InvalidPrivateAccess The value of PrivateAccess for private network access does not match the expectation.
    InvalidParameter.InvalidRestartType The value of RestartType does not match the expected restart mode.
    InvalidParameter.InvalidType The value of Type does not match the expected value.
    InvalidParameter.InvalidVoucherIds The value of the voucher ID list VoucherIds does not match the expectation.
    InvalidParameterValue.ChargeType Invalid parameter value for billing type ChargeType.
    InvalidParameterValue.ConfigInfo Component configuration value error.
    InvalidParameterValue.EsConfigType Invalid ES configuration type.
    InvalidParameterValue.InstanceName Instance name verification failed. Enter it according to the rule.
    InvalidParameterValue.InvalidDeadline Deadline conflict.
    LimitExceeded.UpdateItemLimit Too many update parameter values. The limit is exceeded.
    ResourceInUse The resource is occupied.
    ResourceInUse.Order Order locked.
    ResourceInsufficient Insufficient resources.
    ResourceInsufficient.Balance The account balance is insufficient.
    ResourceNotFound.ClusterInfoNotFound Failed to obtain the cluster resource.
    ResourceNotFound.DataNodeNotFound Data node information not found.
    ResourceNotFound.DiskInfoNotFound Failed to obtain disk-related resources.
    ResourceNotFound.TradeCgwNotFound Failed to obtain the billing resource.
    UnauthorizedOperation.UinNotInWhiteList Uin is not in the allowlist.
    UnsupportedOperation The operation is not supported.
    UnsupportedOperation.BasicSecurityType Authentication method not supported.
    UnsupportedOperation.ClusterStateNoReplication Some indexes in the cluster have no backup.
    UnsupportedOperation.ClusterStateUnHealth Cluster status is abnormal (not green).
    UnsupportedOperation.HeteroScalingExecuting An incomplete heterogeneous scaling process exists.
    UnsupportedOperation.InstanceTypeError This operation is not supported. The service type is incorrect.
    UnsupportedOperation.LicenseError The operation is not supported. The license type is incorrect.
    UnsupportedOperation.LocalDisk Local disk models are not supported.
    UnsupportedOperation.MultiZonesUpgrade Configuration adjustments across multiple availability zones are not supported.
    UnsupportedOperation.Plugin The plugin is not supported.

    Help and Support

    Was this page helpful?

    Help us improve! Rate your documentation experience in 5 mins.

    Feedback