Domain name for API request: es.intl.tencentcloudapi.com.
Upgrades the edition of an ES cluster
A maximum of 20 requests can be initiated per second for this API.
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: UpgradeInstance. |
| 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 |
| EsVersion | Yes | String | Target ES version. Valid values: "6.4.3", "6.8.2", "7.5.1", "7.10.1", and "7.14.2". |
| CheckOnly | No | Boolean | Whether to perform an upgrade check only. Default value: false. |
| LicenseType | No | String | Target business feature version: |
| BasicSecurityType | No | Integer | Whether xpack security authentication is enabled for basic version 6.8 (and above versions) |
| UpgradeMode | No | String | Upgrade method: |
| CosBackup | No | Boolean | Whether to back up the cluster before upgrading the version. By default, no backup is performed. |
| SkipCheckForceRestart | No | Boolean | In rolling mode, whether to skip the check and perform a forced reboot. Default value: false |
| CvmDelayOnlineTime | No | Integer | Parameter for delayed cvm launch |
| ShardAllocationConcurrents | No | Integer | Number of concurrent shard migrations |
| ShardAllocationBytes | No | Integer | Shard migration concurrency speed |
| EnableScheduleRecoverGroup | No | Boolean | Whether to enable the placement group asynchronous task |
| EnableScheduleOperationDuration | No | EnableScheduleOperationDuration | Time period of the async task for the placement group |
| Parameter Name | Type | Description |
|---|---|---|
| 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. |
Upgrade ES cluster edition
POST / HTTP/1.1
Host: es.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpgradeInstance
<Common request parameters>
{
"InstanceId": "es-xxxxxxxx",
"EsVersion": "6.4.3"
}{
"Response": {
"RequestId": "c96a110c-7493-452d-a99b-683d07xxxxxx"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 | Cluster status error. |
| FailedOperation.NoPayment | The account is not bound to a credit card or paypal and cannot pay. |
| InternalError | Internal error. |
| InvalidParameter.InvalidAppId | The APPID value 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.InvalidNodeType | The value of NodeType does not match the expected value. |
| InvalidParameterValue.ConfigInfo | Component configuration value error. |
| InvalidParameterValue.UpgradeMode | Invalid value of the upgrade method parameter UpgradeMode. |
| LimitExceeded.NodeNumOrIndices | Node count or index storage volume exceeds the limit. |
| LimitExceeded.ResourceLimit | Exceed the maximum resource limit a user can possess. |
| ResourceInsufficient.Balance | The account balance is insufficient. |
| ResourceInsufficient.SubnetIp | Insufficient available subnet IP. |
| ResourceNotFound.ClusterInfoNotFound | Failed to obtain the cluster resource. |
| ResourceNotFound.DBInfoNotFound | Failed to obtain the database resource. |
| ResourceNotFound.WhiteListNotFound | Failed to obtain the allowlist resource. |
| UnauthorizedOperation.UinNotInWhiteList | Uin is not in the allowlist. |
| UnsupportedOperation.ClusterStateClose | Some indexes in the cluster are closed. |
| UnsupportedOperation.ClusterStateNoReplication | Some indexes in the cluster have no backup. |
| UnsupportedOperation.ClusterStateUnHealth | Cluster status is abnormal (not green). |
| UnsupportedOperation.CosBackUp | Unsupported version for cos Backup. The cluster must be restarted to allow cos Backup. |
| UnsupportedOperation.HeteroScalingExecuting | An incomplete heterogeneous scaling process exists. |
| UnsupportedOperation.IndexSettingsRequireSet | The cluster has the index setting index.routing.allocation.require._name, _ip, or _id. |
| UnsupportedOperation.LicenseError | The operation is not supported. The license type is incorrect. |
| UnsupportedOperation.Plugin | The plugin is not supported. |
| UnsupportedOperation.StatusNotSupport | This operation is not supported. The instance status is incorrect. |
Apakah halaman ini membantu?
Anda juga dapat Menghubungi Penjualan atau Mengirimkan Tiket untuk meminta bantuan.
masukan