Documentation

Recent Pages

UpgradeLicense

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

1. API Description

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

This API is used to upgrade ES X-Pack.

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: UpgradeLicense.
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
LicenseType	Yes	String	License type oss: Open Source Edition basic: Basic Edition platinum: Platinum Edition Default value: Platinum
AutoVoucher	No	Integer	Whether to automatically use vouchers 0: No 1: Yes Default value: 0
VoucherIds.N	No	Array of String	List of voucher IDs (only one voucher can be specified at a time currently)
BasicSecurityType	No	Integer	Whether to enable X-Pack security authentication in Basic Edition 6.8 (and above) 1: disabled 2: enabled
ForceRestart	No	Boolean	Whether to force restart true: yes false: no Default value: false

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 Upgrading ES X-Pack

Input Example

https://es.tencentcloudapi.com/?Action=UpgradeLicense
&InstanceId=es-xxxxxxxx
&LicenseType=platinum
&<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.

API 3.0 Explorer

SDK

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

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.

Error Code	Description
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.
UnsupportedOperation	Unsupported operation.