EsClient (tencentcloud-sdk-java 3.1.136 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.es.v20180416.EsClient

public class EsClient
extends AbstractClient

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractClient
  gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors
Constructor and Description

EsClient(Credential credential, String region)

EsClient(Credential credential, String region, ClientProfile profile)

Constructors
Constructor and Description
`EsClient(Credential credential, String region)`
`EsClient(Credential credential, String region, ClientProfile profile)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateInstanceResponse`	`CreateInstance(CreateInstanceRequest req)` 创建指定规格的ES集群实例
`DeleteInstanceResponse`	`DeleteInstance(DeleteInstanceRequest req)` 销毁集群实例
`DescribeInstanceLogsResponse`	`DescribeInstanceLogs(DescribeInstanceLogsRequest req)` 查询用户该地域下符合条件的ES集群的日志
`DescribeInstanceOperationsResponse`	`DescribeInstanceOperations(DescribeInstanceOperationsRequest req)` 查询实例指定条件下的操作记录
`DescribeInstancesResponse`	`DescribeInstances(DescribeInstancesRequest req)` 查询用户该地域下符合条件的所有实例
`RestartInstanceResponse`	`RestartInstance(RestartInstanceRequest req)` 重启ES集群实例(用于系统版本更新等操作)
`RestartNodesResponse`	`RestartNodes(RestartNodesRequest req)` 用于重启集群节点
`UpdateInstanceResponse`	`UpdateInstance(UpdateInstanceRequest req)` 对集群进行节点规格变更，修改实例名称，修改配置，重置密码，添加Kibana黑白名单等操作。参数中InstanceId为必传参数，ForceRestart为选填参数，剩余参数传递组合及含义如下： - InstanceName：修改实例名称(仅用于标识实例) - NodeInfoList: 修改节点配置（节点横向扩缩容，纵向扩缩容，增加主节点，增加冷节点等） - EsConfig：修改集群配置 - Password：修改默认用户elastic的密码 - EsAcl：修改访问控制列表 - CosBackUp: 设置集群COS自动备份信息以上参数组合只能传递一种，多传或少传均会导致请求失败
`UpdatePluginsResponse`	`UpdatePlugins(UpdatePluginsRequest req)` 变更插件列表
`UpgradeInstanceResponse`	`UpgradeInstance(UpgradeInstanceRequest req)` 升级ES集群版本
`UpgradeLicenseResponse`	`UpgradeLicense(UpgradeLicenseRequest req)` 升级ES商业特性

Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, getClientProfile, getCredential, getRegion, internalRequest, setClientProfile, setCredential, setRegion

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - EsClient
```
public EsClient(Credential credential,
                String region)
```
  - EsClient
```
public EsClient(Credential credential,
                String region,
                ClientProfile profile)
```
- Method Detail
  - CreateInstance
```
public CreateInstanceResponse CreateInstance(CreateInstanceRequest req)
                                      throws TencentCloudSDKException
```
    创建指定规格的ES集群实例
    
    Parameters:
    
    req - CreateInstanceRequest
    
    Returns:
    
    CreateInstanceResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteInstance
```
public DeleteInstanceResponse DeleteInstance(DeleteInstanceRequest req)
                                      throws TencentCloudSDKException
```
    销毁集群实例
    
    Parameters:
    
    req - DeleteInstanceRequest
    
    Returns:
    
    DeleteInstanceResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeInstanceLogs
```
public DescribeInstanceLogsResponse DescribeInstanceLogs(DescribeInstanceLogsRequest req)
                                                  throws TencentCloudSDKException
```
    查询用户该地域下符合条件的ES集群的日志
    
    Parameters:
    
    req - DescribeInstanceLogsRequest
    
    Returns:
    
    DescribeInstanceLogsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeInstanceOperations
```
public DescribeInstanceOperationsResponse DescribeInstanceOperations(DescribeInstanceOperationsRequest req)
                                                              throws TencentCloudSDKException
```
    查询实例指定条件下的操作记录
    
    Parameters:
    
    req - DescribeInstanceOperationsRequest
    
    Returns:
    
    DescribeInstanceOperationsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeInstances
```
public DescribeInstancesResponse DescribeInstances(DescribeInstancesRequest req)
                                            throws TencentCloudSDKException
```
    查询用户该地域下符合条件的所有实例
    
    Parameters:
    
    req - DescribeInstancesRequest
    
    Returns:
    
    DescribeInstancesResponse
    
    Throws:
    
    TencentCloudSDKException
  - RestartInstance
```
public RestartInstanceResponse RestartInstance(RestartInstanceRequest req)
                                        throws TencentCloudSDKException
```
    重启ES集群实例(用于系统版本更新等操作)
    
    Parameters:
    
    req - RestartInstanceRequest
    
    Returns:
    
    RestartInstanceResponse
    
    Throws:
    
    TencentCloudSDKException
  - RestartNodes
```
public RestartNodesResponse RestartNodes(RestartNodesRequest req)
                                  throws TencentCloudSDKException
```
    用于重启集群节点
    
    Parameters:
    
    req - RestartNodesRequest
    
    Returns:
    
    RestartNodesResponse
    
    Throws:
    
    TencentCloudSDKException
  - UpdateInstance
```
public UpdateInstanceResponse UpdateInstance(UpdateInstanceRequest req)
                                      throws TencentCloudSDKException
```
    对集群进行节点规格变更，修改实例名称，修改配置，重置密码，添加Kibana黑白名单等操作。参数中InstanceId为必传参数，ForceRestart为选填参数，剩余参数传递组合及含义如下： - InstanceName：修改实例名称(仅用于标识实例) - NodeInfoList: 修改节点配置（节点横向扩缩容，纵向扩缩容，增加主节点，增加冷节点等） - EsConfig：修改集群配置 - Password：修改默认用户elastic的密码 - EsAcl：修改访问控制列表 - CosBackUp: 设置集群COS自动备份信息以上参数组合只能传递一种，多传或少传均会导致请求失败
    
    Parameters:
    
    req - UpdateInstanceRequest
    
    Returns:
    
    UpdateInstanceResponse
    
    Throws:
    
    TencentCloudSDKException
  - UpdatePlugins
```
public UpdatePluginsResponse UpdatePlugins(UpdatePluginsRequest req)
                                    throws TencentCloudSDKException
```
    变更插件列表
    
    Parameters:
    
    req - UpdatePluginsRequest
    
    Returns:
    
    UpdatePluginsResponse
    
    Throws:
    
    TencentCloudSDKException
  - UpgradeInstance
```
public UpgradeInstanceResponse UpgradeInstance(UpgradeInstanceRequest req)
                                        throws TencentCloudSDKException
```
    升级ES集群版本
    
    Parameters:
    
    req - UpgradeInstanceRequest
    
    Returns:
    
    UpgradeInstanceResponse
    
    Throws:
    
    TencentCloudSDKException
  - UpgradeLicense
```
public UpgradeLicenseResponse UpgradeLicense(UpgradeLicenseRequest req)
                                      throws TencentCloudSDKException
```
    升级ES商业特性
    
    Parameters:
    
    req - UpgradeLicenseRequest
    
    Returns:
    
    UpgradeLicenseResponse
    
    Throws:
    
    TencentCloudSDKException

Class EsClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractClient

Methods inherited from class java.lang.Object

Constructor Detail

EsClient

EsClient

Method Detail

CreateInstance

DeleteInstance

DescribeInstanceLogs

DescribeInstanceOperations

DescribeInstances

RestartInstance

RestartNodes

UpdateInstance

UpdatePlugins

UpgradeInstance

UpgradeLicense