Domain name for API request: es.intl.tencentcloudapi.com.
Perform operations on the cluster, such as node specification change, instance name modification, configuration modification, password resetting, and Kibana blocklist/allowlist addition. InstanceId is a required parameter, while ForceRestart is optional. The remaining parameter combinations and their meanings are as follows:
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: UpdateInstance. |
| 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 |
| InstanceName | No | String | Instance name (1-50 English letters, Chinese characters, digits, hyphens -, or underscores _) |
| NodeNum | No | Integer | Abandoned. Please use NodeInfoList. Number of nodes (2-50). |
| EsConfig | No | String | ES configuration item (JSON format string) |
| Password | No | String | Password of the default user elastic (8–16 characters, including at least two of the following: [a-z,A-Z], [0-9], and special characters [-!@#$%&^*+=_:;,.?]) |
| EsAcl | No | EsAcl | Public access policy for visualization components (Kibana and Cerebro) |
| DiskSize | No | Integer | Abandoned. Please use NodeInfoList. Disk size in GB |
| NodeType | No | String | Abandoned. Please use NodeInfoList. Node specification |
| MasterNodeNum | No | Integer | Abandoned. Please use NodeInfoList. Number of dedicated primary nodes (supports only 3 or 5) |
| MasterNodeType | No | String | Abandoned. Please use NodeInfoList. Dedicated primary node specification |
| MasterNodeDiskSize | No | Integer | Abandoned. Please use NodeInfoList. Dedicated primary node disk size (in GB. The system default configuration is 50 GB. Customization is temporarily not supported.) |
| ForceRestart | No | Boolean | Whether to force restart when updating the configuration |
| CosBackup | No | CosBackup | COS auto backup information |
| NodeInfoList.N | No | Array of NodeInfo | Node information list. You can transmit only the node to be updated and its corresponding specification information. Supported operations include |
| PublicAccess | No | String | Public access status of the ES cluster OPEN: enabled. -CLOSE: disabled. |
| EsPublicAcl | No | EsPublicAcl | Public network access control list |
| KibanaPublicAccess | No | String | Kibana public access status OPEN: enabled. -CLOSE: disabled. |
| KibanaPrivateAccess | No | String | Kibana internal access status OPEN: enabled. -CLOSE: disabled. |
| BasicSecurityType | No | Integer | Turn on or off user authentication for the basic version of ES 6.8 and above |
| KibanaPrivatePort | No | Integer | Kibana private network port |
| ScaleType | No | Integer | 0: Scale out via blue-green change without restarting the cluster (default) 1: Scale out by unmounting disks with a cluster rolling restart |
| MultiZoneInfo.N | No | Array of ZoneDetail | Multi-AZ deployment |
| SceneType | No | Integer | Scenario template type. -1: not enabled. 1: common. 2: log. 3: search |
| KibanaConfig | No | String | Kibana configuration item (JSON format string) |
| WebNodeTypeInfo | No | WebNodeTypeInfo | Visualize node configuration |
| SwitchPrivateLink | No | String | Switch to the new network architecture |
| EnableCerebro | No | Boolean | Enable Cerebro |
| CerebroPublicAccess | No | String | Cerebro public access status OPEN: enabled. -CLOSE: disabled. |
| CerebroPrivateAccess | No | String | Cerebro private network access status OPEN: enabled. -CLOSE: disabled. |
| EsConfigSet | No | EsConfigSetInfo | Newly-added or modified configuration group information |
| OperationDuration | No | OperationDurationUpdated | Maintenance time slot. |
| KibanaAlteringPublicAccess | No | String | Whether Alerting public network alert output is enabled: OPEN: enabled. -CLOSE: disabled. |
| KibanaPrivateDomain | No | String | Custom domain name of kibana on the private network |
| CerebroPrivateDomain | No | String | Custom domain name of cerebro on the private network |
| Protocol | No | String | Change to an https cluster. http is selected by default. |
| OutboundPublicAcls.N | No | Array of OutboundPublicAcl | Outbound access details of the node |
| OutboundPublicAccess | No | String | Outbound access operations of the node OPEN -CLOSE: disabled. |
| CvmDelayOnlineTime | No | Integer | Parameter for delayed cvm launch |
| ShardAllocationConcurrents | No | Integer | Number of concurrent shard migrations |
| ShardAllocationBytes | No | Integer | Shard migration concurrency speed |
| ReadWriteMode | No | Integer | Read-write separation mode: -1: not enabled; 1: local read/write separation; 2: remote read/write separation. |
| EnableScheduleRecoverGroup | No | Boolean | Whether to enable the placement group async task |
| EnableScheduleOperationDuration | No | EnableScheduleOperationDuration | Placement group async task maintenance time slot |
| EnableDestroyProtection | No | String | Cluster protection: OPEN: enable, CLOSE: disable |
| AutoScaleDiskInfoList.N | No | Array of AutoScaleDiskInfo | Auto capacity expansion parameter |
| AutoScaleDiskDeleteNodeTypeList.N | No | Array of String | Auto-expansion delete parameter |
| OtherConfig | No | OtherConfig | Other additional configuration, jvm or yml. |
| 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. |
Used to perform shard scaling on the node specification (cores, memory size) and disk capacity of a cluster (currently only support vertical scale-out).
POST / HTTP/1.1
Host: es.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateInstance
<Common request parameters>
{
"InstanceId": "es-xxxxxxxx",
"DiskSize": 150,
"NodeType": "ES.S1.MEDIUM4"
}{
"Response": {
"RequestId": "1",
"DealName": "1"
}
}This is used to horizontally scale, vertically scale, add dedicated master nodes, horizontally scale dedicated master nodes, and vertically scale dedicated master nodes for a specified ES cluster instance. NodeInfoList should transmit the information of all target nodes.
POST / HTTP/1.1
Host: es.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateInstance
<Common request parameters>
{
"InstanceId": "es-xxxxxx",
"NodeInfoList": [
{
"NodeType": "ES.S1.SMALL2",
"NodeNum": 3,
"Type": "dedicatedMaster"
},
{
"DiskSize": 100,
"NodeType": "ES.S1.SMALL2",
"NodeNum": 2,
"Type": "hotData",
"DiskType": "CLOUD_SSD"
}
]
}{
"Response": {
"RequestId": "1",
"DealName": "1"
}
}Used to modify the name of a specified ES cluster instance.
POST / HTTP/1.1
Host: es.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateInstance
<Common request parameters>
{
"InstanceId": "es-xxxxxx",
"InstanceName": "newName"
}{
"Response": {
"RequestId": "1",
"DealName": "1"
}
}Used to make modifications to the configuration of a specified ES cluster instance.
POST / HTTP/1.1
Host: es.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateInstance
<Common request parameters>
{
"InstanceId": "es-xxxxxxxx",
"EsConfig": "{\"action.destructive_requires_name\":\"true\"}"
}{
"Response": {
"RequestId": "1",
"DealName": "1"
}
}Reset the Kibana password of a specified ES cluster instance.
POST / HTTP/1.1
Host: es.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateInstance
<Common request parameters>
{
"InstanceId": "es-xxxxxxxx",
"Password": "newPwd_123"
}{
"Response": {
"RequestId": "1",
"DealName": "1"
}
}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 | Operation failed. |
| FailedOperation.CdcQuotaInsufficient | Insufficient resource pack quota in the availability zone. |
| FailedOperation.ErrorClusterState | Cluster status error. |
| 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. |
| FailedOperation.UnsupportedLocalDiskRollUpScaleUpOrDown | Scaling a local disk cluster via rolling restart is not supported. |
| FailedOperation.UnsupportedResetNodeTypeAndScaleOutDisk | Rolling restart to scale computational resources and disk quantity at the same time is not supported. |
| FailedOperation.UnsupportedRestScaleDownAndModifyDisk | Rolling restart to reduce computational resources and adjust disk size at the same time is not supported. |
| FailedOperation.UnsupportedReverseRegulationNodeTypeAndDisk | Unsupported backward adjustment of node configuration and disk capacity. |
| InternalError | Internal 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.InvalidClusterName | The value of ClusterName does not match the expected value. |
| 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.InvalidDiskEncrypt | The value of the node disk encryption information DiskEncrypt 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.InvalidEsACL | The EsAcl value 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.InvalidMultiZoneInfo | The information of ZoneDetail in multi-AZ deployment does not meet expectations. |
| 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.InvalidOperationDuration | The value of the maintenance time slot OperationDuration does not match the expectation. |
| InvalidParameter.InvalidPrivateAccess | The value of PrivateAccess for private network access does not match the expectation. |
| InvalidParameter.InvalidPublicAccess | The value of PublicAccess for public network access does not match the expectation. |
| InvalidParameter.InvalidRegion | The Region value does not meet the expectation. |
| InvalidParameter.InvalidRestartType | The value of RestartType does not match the expected restart mode. |
| InvalidParameter.InvalidSubnetId | The value of SubnetId for the subnet ID does not meet expectations. |
| InvalidParameter.InvalidType | The value of Type does not match the expected value. |
| InvalidParameter.InvalidUpdateType | The value of the update type UpdateType does not match the expected value. |
| InvalidParameter.InvalidVoucherIds | The value of the voucher ID list VoucherIds does not match the expectation. |
| InvalidParameter.InvalidZone | The information of the availability zone Zone does not meet expectations. |
| 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. |
| InvalidParameterValue.Password | Password verification is invalid. |
| LimitExceeded.UpdateItemLimit | Too many update parameter values. The limit is exceeded. |
| ResourceInUse | The resource is occupied. |
| ResourceInUse.Order | Order locked. |
| ResourceInsufficient.Balance | The account balance is insufficient. |
| ResourceInsufficient.CVM | Insufficient computing resources. Replace the availability zone or adjust the model. |
| ResourceInsufficient.Subnet | Insufficient remaining IPs in subnet. |
| ResourceInsufficient.SubnetIp | Insufficient available subnet IP. |
| ResourceNotFound.ClusterInfoNotFound | Failed to obtain the cluster resource. |
| ResourceNotFound.DBInfoNotFound | Failed to obtain the database resource. |
| ResourceNotFound.DiskInfoNotFound | Failed to obtain disk-related resources. |
| ResourceNotFound.TradeCgwNotFound | Failed to obtain the billing resource. |
| ResourceNotFound.VPCInfoNotFound | Failed to obtain the VPC resource. |
| ResourceNotFound.WhiteListNotFound | Failed to obtain the allowlist resource. |
| UnauthorizedOperation.UinNotInWhiteList | Uin is not in the allowlist. |
| UnsupportedOperation | The operation is not supported. |
| UnsupportedOperation.BasicSecurityType | Authentication method not supported. |
| UnsupportedOperation.ChangeNodeType | Configuration adjustments are not supported for node or disk. |
| UnsupportedOperation.CloseHttpsWithSaml | saml logon is enabled for the cluster. You cannot switch directly from https to http protocol. |
| UnsupportedOperation.ClusterShardNum | Does not support this operation. Allocated tablets exist in the cluster. |
| 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.CvmStateNotSupported | The current running status of cvm is unsupported. |
| UnsupportedOperation.CvmStatusStopped | cvm instances that are shut down |
| UnsupportedOperation.DiskNotPortable | This operation only supports elastic cloud disks. |
| UnsupportedOperation.DiskStateNotSupported | Current disk status not supported |
| UnsupportedOperation.DiskTypeChangePathNotSupported | Disk type modification path not supported |
| 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.KernelNotSupportGpu | The current ES cluster edition is too low and does not support Gpu machines. |
| UnsupportedOperation.LicenseError | The operation is not supported. The license type is incorrect. |
| UnsupportedOperation.MultiZonesUpgrade | Configuration adjustments across multiple availability zones are not supported. |
| UnsupportedOperation.NotDataDisk | This operation only supports data disks. |
| UnsupportedOperation.Plugin | The plugin is not supported. |
| UnsupportedOperation.ScaleDownTooMuch | Vertically scale in too many resources. |
| UnsupportedOperation.SingleNodeClusterNotSupport | This operation is not supported for single-node instances. |
| UnsupportedOperation.StatusNotNormal | This operation is not supported. The instance is not running as normal. |
| UnsupportedOperation.StatusNotSupport | This operation is not supported. The instance status is incorrect. |
| UnsupportedOperation.UpdateDiskType | Disk type update not supported. |
| UnsupportedOperation.WebServiceType | Unsupported web component. |
Apakah halaman ini membantu?
Anda juga dapat Menghubungi Penjualan atau Mengirimkan Tiket untuk meminta bantuan.
masukan