Domain name for API request: es.intl.tencentcloudapi.com.
This API is used to upgrade ES X-Pack.
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: 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 |
| AutoVoucher | No | Integer | Whether to automatically use vouchers |
| 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) |
| ForceRestart | No | Boolean | Whether to force restart |
| 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, 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. |
https://es.intl.tencentcloudapi.com/?Action=UpgradeLicense
&InstanceId=es-xxxxxxxx
&LicenseType=platinum
&<Common request parameters>
{
"Response": {
"RequestId": "xx",
"DealName": "xx"
}
}
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.EsDictionaryInfoError | |
| FailedOperation.NoPayment | No credit card or PayPal account is linked to the current account. Unable to make a payment. |
| FailedOperation.NotAuthenticated | Unverified user. |
| InternalError | Internal error. |
| InvalidParameter | Invalid parameter. |
| InvalidParameter.InvalidAppId | The APPID value does not match the expectation. |
| InvalidParameter.InvalidAutoVoucher | |
| InvalidParameter.InvalidCosBackupInfo | |
| InvalidParameter.InvalidDiskCount | |
| InvalidParameter.InvalidDiskSize | |
| InvalidParameter.InvalidDiskType | |
| InvalidParameter.InvalidEsVersion | The instance version EsVersion does not match the expectation. |
| InvalidParameter.InvalidInstanceId | Invalid InstanceId, no corresponding resource found. |
| InvalidParameter.InvalidKibanaPrivatePort | |
| InvalidParameter.InvalidNodeNum | |
| InvalidParameter.InvalidNodeType | |
| InvalidParameter.InvalidOpType | |
| InvalidParameter.InvalidPrivateAccess | |
| InvalidParameter.InvalidRestartType | |
| InvalidParameter.InvalidType | |
| InvalidParameter.InvalidVoucherIds | |
| InvalidParameterValue.ChargeType | |
| InvalidParameterValue.ConfigInfo | |
| InvalidParameterValue.EsConfigType | |
| InvalidParameterValue.InstanceName | |
| InvalidParameterValue.InvalidDeadline | |
| LimitExceeded.UpdateItemLimit | |
| ResourceInUse | Resource is in use. |
| ResourceInUse.Order | |
| ResourceInsufficient | Insufficient resource. |
| ResourceInsufficient.Balance | Insufficient account balance. |
| ResourceNotFound.ClusterInfoNotFound | Failed to obtain cluster resources. |
| ResourceNotFound.DataNodeNotFound | |
| ResourceNotFound.DiskInfoNotFound | |
| ResourceNotFound.TradeCgwNotFound | |
| UnauthorizedOperation.UinNotInWhiteList | |
| UnsupportedOperation | Unsupported operation. |
| UnsupportedOperation.BasicSecurityType | |
| UnsupportedOperation.ClusterStateNoReplication | |
| UnsupportedOperation.ClusterStateUnHealth | |
| UnsupportedOperation.HeteroScalingExecuting | |
| UnsupportedOperation.InstanceTypeError | |
| UnsupportedOperation.LicenseError | |
| UnsupportedOperation.LocalDisk | |
| UnsupportedOperation.MultiZonesUpgrade | |
| UnsupportedOperation.Plugin | The plugin is not supported. |
フィードバック