UpgradeInstance

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2020-12-11 16:14:12

Download PDF

1. API Description

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

This API is used to upgrade ES cluster version

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: UpgradeInstance.
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
EsVersion	Yes	String	Target ES version. Valid values: 6.4.3, 6.8.2, 7.5.1
CheckOnly	No	Boolean	Whether to check for upgrade only. Default value: false
LicenseType	No	String	Target X-Pack edition: OSS: Open-source Edition basic: Basic Edition Currently only used for v5.6.4 to v6.x upgrade. Default value: basic
BasicSecurityType	No	Integer	Whether to enable X-Pack security authentication in Basic Edition 6.8 (and above) 1: disabled 2: enabled
UpgradeMode	No	String	Upgrade mode. scale: blue/green deployment restart: rolling restart Default value: scale

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 cluster version

Input Example

https://es.tencentcloudapi.com/?Action=UpgradeInstance
&InstanceId=es-xxxxxxxx
&EsVersion=6.4.3
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "c96a110c-7493-452d-a99b-683d07xxxxxx"
  }
}

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

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

Recent Pages