EsClient (tencentcloud-sdk-java 3.0.112 API)

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

public class EsClient
extends AbstractClient

字段概要
- 从类继承的字段 com.tencentcloudapi.common.AbstractClient
  gson, HTTP_RSP_OK, SDK_VERSION

构造器概要

构造器
构造器和说明
`EsClient(Credential credential, String region)` 构造client
`EsClient(Credential credential, String region, ClientProfile profile)` 构造client

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`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集群实例(用于系统版本更新等操作)
`UpdateInstanceResponse`	`UpdateInstance(UpdateInstanceRequest req)` 对集群进行扩缩容，修改实例名称，修改配置，重置密码，添加Kibana黑白名单等操作。
`UpgradeInstanceResponse`	`UpgradeInstance(UpgradeInstanceRequest req)` 升级ES集群版本
`UpgradeLicenseResponse`	`UpgradeLicense(UpgradeLicenseRequest req)` 升级ES商业特性

从类继承的方法 com.tencentcloudapi.common.AbstractClient
call, getClientProfile, getCredential, getRegion, internalRequest, setClientProfile, setCredential, setRegion

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

类 EsClient

字段概要

从类继承的字段 com.tencentcloudapi.common.AbstractClient

构造器概要

方法概要

从类继承的方法 com.tencentcloudapi.common.AbstractClient

从类继承的方法 java.lang.Object

构造器详细资料

EsClient

EsClient

方法详细资料

CreateInstance

DeleteInstance

DescribeInstanceLogs

DescribeInstanceOperations

DescribeInstances

RestartInstance

UpdateInstance

UpgradeInstance

UpgradeLicense