EsClient (tencentcloud-sdk-java 3.1.796 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
`CreateIndexResponse`	`CreateIndex(CreateIndexRequest req)` 创建索引
`CreateInstanceResponse`	`CreateInstance(CreateInstanceRequest req)` 创建指定规格的ES集群实例
`CreateLogstashInstanceResponse`	`CreateLogstashInstance(CreateLogstashInstanceRequest req)` 用于创建Logstash实例
`DeleteIndexResponse`	`DeleteIndex(DeleteIndexRequest req)` 删除索引
`DeleteInstanceResponse`	`DeleteInstance(DeleteInstanceRequest req)` 销毁集群实例
`DeleteLogstashInstanceResponse`	`DeleteLogstashInstance(DeleteLogstashInstanceRequest req)` 用于删除Logstash实例
`DeleteLogstashPipelinesResponse`	`DeleteLogstashPipelines(DeleteLogstashPipelinesRequest req)` 用于批量删除Logstash管道
`DescribeIndexListResponse`	`DescribeIndexList(DescribeIndexListRequest req)` 获取索引列表
`DescribeIndexMetaResponse`	`DescribeIndexMeta(DescribeIndexMetaRequest req)` 获取索引元数据
`DescribeInstanceLogsResponse`	`DescribeInstanceLogs(DescribeInstanceLogsRequest req)` 查询用户该地域下符合条件的ES集群的日志
`DescribeInstanceOperationsResponse`	`DescribeInstanceOperations(DescribeInstanceOperationsRequest req)` 查询实例指定条件下的操作记录
`DescribeInstancesResponse`	`DescribeInstances(DescribeInstancesRequest req)` 查询用户该地域下符合条件的所有实例
`DescribeLogstashInstanceLogsResponse`	`DescribeLogstashInstanceLogs(DescribeLogstashInstanceLogsRequest req)` 查询用户该地域下符合条件的Logstash实例的日志
`DescribeLogstashInstanceOperationsResponse`	`DescribeLogstashInstanceOperations(DescribeLogstashInstanceOperationsRequest req)` 查询实例指定条件下的操作记录
`DescribeLogstashInstancesResponse`	`DescribeLogstashInstances(DescribeLogstashInstancesRequest req)` 查询用户该地域下符合条件的所有Logstash实例
`DescribeLogstashPipelinesResponse`	`DescribeLogstashPipelines(DescribeLogstashPipelinesRequest req)` 用于获取Logstash实例管道列表
`DescribeViewsResponse`	`DescribeViews(DescribeViewsRequest req)` 查询集群各视图数据，包括集群维度、节点维度、Kibana维度
`DiagnoseInstanceResponse`	`DiagnoseInstance(DiagnoseInstanceRequest req)` 智能运维诊断集群
`GetRequestTargetNodeTypesResponse`	`GetRequestTargetNodeTypes(GetRequestTargetNodeTypesRequest req)` 获取接收客户端请求的节点类型
`RestartInstanceResponse`	`RestartInstance(RestartInstanceRequest req)` 重启ES集群实例(用于系统版本更新等操作)
`RestartKibanaResponse`	`RestartKibana(RestartKibanaRequest req)` 重启Kibana
`RestartLogstashInstanceResponse`	`RestartLogstashInstance(RestartLogstashInstanceRequest req)` 用于重启Logstash实例
`RestartNodesResponse`	`RestartNodes(RestartNodesRequest req)` 用于重启集群节点
`SaveAndDeployLogstashPipelineResponse`	`SaveAndDeployLogstashPipeline(SaveAndDeployLogstashPipelineRequest req)` 用于下发并且部署管道
`StartLogstashPipelinesResponse`	`StartLogstashPipelines(StartLogstashPipelinesRequest req)` 用于启动Logstash管道
`StopLogstashPipelinesResponse`	`StopLogstashPipelines(StopLogstashPipelinesRequest req)` 用于批量停止Logstash管道
`UpdateDiagnoseSettingsResponse`	`UpdateDiagnoseSettings(UpdateDiagnoseSettingsRequest req)` 更新智能运维配置
`UpdateDictionariesResponse`	`UpdateDictionaries(UpdateDictionariesRequest req)` 更新ES集群词典
`UpdateIndexResponse`	`UpdateIndex(UpdateIndexRequest req)` 更新索引
`UpdateInstanceResponse`	`UpdateInstance(UpdateInstanceRequest req)` 对集群进行节点规格变更，修改实例名称，修改配置，重置密码，添加Kibana黑白名单等操作。参数中InstanceId为必传参数，ForceRestart为选填参数，剩余参数传递组合及含义如下： - InstanceName：修改实例名称(仅用于标识实例) - NodeInfoList: 修改节点配置（节点横向扩缩容，纵向扩缩容，增加主节点，增加冷节点等） - EsConfig：修改集群配置 - Password：修改默认用户elastic的密码 - EsAcl：修改访问控制列表 - CosBackUp: 设置集群COS自动备份信息以上参数组合只能传递一种，多传或少传均会导致请求失败
`UpdateJdkResponse`	`UpdateJdk(UpdateJdkRequest req)` 更新实例Jdk配置
`UpdateLogstashInstanceResponse`	`UpdateLogstashInstance(UpdateLogstashInstanceRequest req)` 对集群进行节点规格变更，修改实例名称，修改配置，等操作。参数中InstanceId为必传参数，参数传递组合及含义如下： - InstanceName：修改实例名称(仅用于标识实例) - NodeNum: 修改实例节点数量（节点横向扩缩容，纵向扩缩容等） - YMLConfig: 修改实例YML配置 - BindedES：修改绑定的ES集群配置以上参数组合只能传递一种，多传或少传均会导致请求失败
`UpdateLogstashPipelineDescResponse`	`UpdateLogstashPipelineDesc(UpdateLogstashPipelineDescRequest req)` 用于更新管道描述信息
`UpdatePluginsResponse`	`UpdatePlugins(UpdatePluginsRequest req)` 变更插件列表
`UpdateRequestTargetNodeTypesResponse`	`UpdateRequestTargetNodeTypes(UpdateRequestTargetNodeTypesRequest req)` 更新接收客户端请求的节点类型
`UpgradeInstanceResponse`	`UpgradeInstance(UpgradeInstanceRequest req)` 升级ES集群版本
`UpgradeLicenseResponse`	`UpgradeLicense(UpgradeLicenseRequest req)` 升级ES商业特性

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

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
  - CreateIndex
```
public CreateIndexResponse CreateIndex(CreateIndexRequest req)
                                throws TencentCloudSDKException
```
    创建索引
    
    Parameters:
    
    req - CreateIndexRequest
    
    Returns:
    
    CreateIndexResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateInstance
```
public CreateInstanceResponse CreateInstance(CreateInstanceRequest req)
                                      throws TencentCloudSDKException
```
    创建指定规格的ES集群实例
    
    Parameters:
    
    req - CreateInstanceRequest
    
    Returns:
    
    CreateInstanceResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateLogstashInstance
```
public CreateLogstashInstanceResponse CreateLogstashInstance(CreateLogstashInstanceRequest req)
                                                      throws TencentCloudSDKException
```
    用于创建Logstash实例
    
    Parameters:
    
    req - CreateLogstashInstanceRequest
    
    Returns:
    
    CreateLogstashInstanceResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteIndex
```
public DeleteIndexResponse DeleteIndex(DeleteIndexRequest req)
                                throws TencentCloudSDKException
```
    删除索引
    
    Parameters:
    
    req - DeleteIndexRequest
    
    Returns:
    
    DeleteIndexResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteInstance
```
public DeleteInstanceResponse DeleteInstance(DeleteInstanceRequest req)
                                      throws TencentCloudSDKException
```
    销毁集群实例
    
    Parameters:
    
    req - DeleteInstanceRequest
    
    Returns:
    
    DeleteInstanceResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteLogstashInstance
```
public DeleteLogstashInstanceResponse DeleteLogstashInstance(DeleteLogstashInstanceRequest req)
                                                      throws TencentCloudSDKException
```
    用于删除Logstash实例
    
    Parameters:
    
    req - DeleteLogstashInstanceRequest
    
    Returns:
    
    DeleteLogstashInstanceResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteLogstashPipelines
```
public DeleteLogstashPipelinesResponse DeleteLogstashPipelines(DeleteLogstashPipelinesRequest req)
                                                        throws TencentCloudSDKException
```
    用于批量删除Logstash管道
    
    Parameters:
    
    req - DeleteLogstashPipelinesRequest
    
    Returns:
    
    DeleteLogstashPipelinesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeIndexList
```
public DescribeIndexListResponse DescribeIndexList(DescribeIndexListRequest req)
                                            throws TencentCloudSDKException
```
    获取索引列表
    
    Parameters:
    
    req - DescribeIndexListRequest
    
    Returns:
    
    DescribeIndexListResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeIndexMeta
```
public DescribeIndexMetaResponse DescribeIndexMeta(DescribeIndexMetaRequest req)
                                            throws TencentCloudSDKException
```
    获取索引元数据
    
    Parameters:
    
    req - DescribeIndexMetaRequest
    
    Returns:
    
    DescribeIndexMetaResponse
    
    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
  - DescribeLogstashInstanceLogs
```
public DescribeLogstashInstanceLogsResponse DescribeLogstashInstanceLogs(DescribeLogstashInstanceLogsRequest req)
                                                                  throws TencentCloudSDKException
```
    查询用户该地域下符合条件的Logstash实例的日志
    
    Parameters:
    
    req - DescribeLogstashInstanceLogsRequest
    
    Returns:
    
    DescribeLogstashInstanceLogsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeLogstashInstanceOperations
```
public DescribeLogstashInstanceOperationsResponse DescribeLogstashInstanceOperations(DescribeLogstashInstanceOperationsRequest req)
                                                                              throws TencentCloudSDKException
```
    查询实例指定条件下的操作记录
    
    Parameters:
    
    req - DescribeLogstashInstanceOperationsRequest
    
    Returns:
    
    DescribeLogstashInstanceOperationsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeLogstashInstances
```
public DescribeLogstashInstancesResponse DescribeLogstashInstances(DescribeLogstashInstancesRequest req)
                                                            throws TencentCloudSDKException
```
    查询用户该地域下符合条件的所有Logstash实例
    
    Parameters:
    
    req - DescribeLogstashInstancesRequest
    
    Returns:
    
    DescribeLogstashInstancesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeLogstashPipelines
```
public DescribeLogstashPipelinesResponse DescribeLogstashPipelines(DescribeLogstashPipelinesRequest req)
                                                            throws TencentCloudSDKException
```
    用于获取Logstash实例管道列表
    
    Parameters:
    
    req - DescribeLogstashPipelinesRequest
    
    Returns:
    
    DescribeLogstashPipelinesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeViews
```
public DescribeViewsResponse DescribeViews(DescribeViewsRequest req)
                                    throws TencentCloudSDKException
```
    查询集群各视图数据，包括集群维度、节点维度、Kibana维度
    
    Parameters:
    
    req - DescribeViewsRequest
    
    Returns:
    
    DescribeViewsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DiagnoseInstance
```
public DiagnoseInstanceResponse DiagnoseInstance(DiagnoseInstanceRequest req)
                                          throws TencentCloudSDKException
```
    智能运维诊断集群
    
    Parameters:
    
    req - DiagnoseInstanceRequest
    
    Returns:
    
    DiagnoseInstanceResponse
    
    Throws:
    
    TencentCloudSDKException
  - GetRequestTargetNodeTypes
```
public GetRequestTargetNodeTypesResponse GetRequestTargetNodeTypes(GetRequestTargetNodeTypesRequest req)
                                                            throws TencentCloudSDKException
```
    获取接收客户端请求的节点类型
    
    Parameters:
    
    req - GetRequestTargetNodeTypesRequest
    
    Returns:
    
    GetRequestTargetNodeTypesResponse
    
    Throws:
    
    TencentCloudSDKException
  - RestartInstance
```
public RestartInstanceResponse RestartInstance(RestartInstanceRequest req)
                                        throws TencentCloudSDKException
```
    重启ES集群实例(用于系统版本更新等操作)
    
    Parameters:
    
    req - RestartInstanceRequest
    
    Returns:
    
    RestartInstanceResponse
    
    Throws:
    
    TencentCloudSDKException
  - RestartKibana
```
public RestartKibanaResponse RestartKibana(RestartKibanaRequest req)
                                    throws TencentCloudSDKException
```
    重启Kibana
    
    Parameters:
    
    req - RestartKibanaRequest
    
    Returns:
    
    RestartKibanaResponse
    
    Throws:
    
    TencentCloudSDKException
  - RestartLogstashInstance
```
public RestartLogstashInstanceResponse RestartLogstashInstance(RestartLogstashInstanceRequest req)
                                                        throws TencentCloudSDKException
```
    用于重启Logstash实例
    
    Parameters:
    
    req - RestartLogstashInstanceRequest
    
    Returns:
    
    RestartLogstashInstanceResponse
    
    Throws:
    
    TencentCloudSDKException
  - RestartNodes
```
public RestartNodesResponse RestartNodes(RestartNodesRequest req)
                                  throws TencentCloudSDKException
```
    用于重启集群节点
    
    Parameters:
    
    req - RestartNodesRequest
    
    Returns:
    
    RestartNodesResponse
    
    Throws:
    
    TencentCloudSDKException
  - SaveAndDeployLogstashPipeline
```
public SaveAndDeployLogstashPipelineResponse SaveAndDeployLogstashPipeline(SaveAndDeployLogstashPipelineRequest req)
                                                                    throws TencentCloudSDKException
```
    用于下发并且部署管道
    
    Parameters:
    
    req - SaveAndDeployLogstashPipelineRequest
    
    Returns:
    
    SaveAndDeployLogstashPipelineResponse
    
    Throws:
    
    TencentCloudSDKException
  - StartLogstashPipelines
```
public StartLogstashPipelinesResponse StartLogstashPipelines(StartLogstashPipelinesRequest req)
                                                      throws TencentCloudSDKException
```
    用于启动Logstash管道
    
    Parameters:
    
    req - StartLogstashPipelinesRequest
    
    Returns:
    
    StartLogstashPipelinesResponse
    
    Throws:
    
    TencentCloudSDKException
  - StopLogstashPipelines
```
public StopLogstashPipelinesResponse StopLogstashPipelines(StopLogstashPipelinesRequest req)
                                                    throws TencentCloudSDKException
```
    用于批量停止Logstash管道
    
    Parameters:
    
    req - StopLogstashPipelinesRequest
    
    Returns:
    
    StopLogstashPipelinesResponse
    
    Throws:
    
    TencentCloudSDKException
  - UpdateDiagnoseSettings
```
public UpdateDiagnoseSettingsResponse UpdateDiagnoseSettings(UpdateDiagnoseSettingsRequest req)
                                                      throws TencentCloudSDKException
```
    更新智能运维配置
    
    Parameters:
    
    req - UpdateDiagnoseSettingsRequest
    
    Returns:
    
    UpdateDiagnoseSettingsResponse
    
    Throws:
    
    TencentCloudSDKException
  - UpdateDictionaries
```
public UpdateDictionariesResponse UpdateDictionaries(UpdateDictionariesRequest req)
                                              throws TencentCloudSDKException
```
    更新ES集群词典
    
    Parameters:
    
    req - UpdateDictionariesRequest
    
    Returns:
    
    UpdateDictionariesResponse
    
    Throws:
    
    TencentCloudSDKException
  - UpdateIndex
```
public UpdateIndexResponse UpdateIndex(UpdateIndexRequest req)
                                throws TencentCloudSDKException
```
    更新索引
    
    Parameters:
    
    req - UpdateIndexRequest
    
    Returns:
    
    UpdateIndexResponse
    
    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
  - UpdateJdk
```
public UpdateJdkResponse UpdateJdk(UpdateJdkRequest req)
                            throws TencentCloudSDKException
```
    更新实例Jdk配置
    
    Parameters:
    
    req - UpdateJdkRequest
    
    Returns:
    
    UpdateJdkResponse
    
    Throws:
    
    TencentCloudSDKException
  - UpdateLogstashInstance
```
public UpdateLogstashInstanceResponse UpdateLogstashInstance(UpdateLogstashInstanceRequest req)
                                                      throws TencentCloudSDKException
```
    对集群进行节点规格变更，修改实例名称，修改配置，等操作。参数中InstanceId为必传参数，参数传递组合及含义如下： - InstanceName：修改实例名称(仅用于标识实例) - NodeNum: 修改实例节点数量（节点横向扩缩容，纵向扩缩容等） - YMLConfig: 修改实例YML配置 - BindedES：修改绑定的ES集群配置以上参数组合只能传递一种，多传或少传均会导致请求失败
    
    Parameters:
    
    req - UpdateLogstashInstanceRequest
    
    Returns:
    
    UpdateLogstashInstanceResponse
    
    Throws:
    
    TencentCloudSDKException
  - UpdateLogstashPipelineDesc
```
public UpdateLogstashPipelineDescResponse UpdateLogstashPipelineDesc(UpdateLogstashPipelineDescRequest req)
                                                              throws TencentCloudSDKException
```
    用于更新管道描述信息
    
    Parameters:
    
    req - UpdateLogstashPipelineDescRequest
    
    Returns:
    
    UpdateLogstashPipelineDescResponse
    
    Throws:
    
    TencentCloudSDKException
  - UpdatePlugins
```
public UpdatePluginsResponse UpdatePlugins(UpdatePluginsRequest req)
                                    throws TencentCloudSDKException
```
    变更插件列表
    
    Parameters:
    
    req - UpdatePluginsRequest
    
    Returns:
    
    UpdatePluginsResponse
    
    Throws:
    
    TencentCloudSDKException
  - UpdateRequestTargetNodeTypes
```
public UpdateRequestTargetNodeTypesResponse UpdateRequestTargetNodeTypes(UpdateRequestTargetNodeTypesRequest req)
                                                                  throws TencentCloudSDKException
```
    更新接收客户端请求的节点类型
    
    Parameters:
    
    req - UpdateRequestTargetNodeTypesRequest
    
    Returns:
    
    UpdateRequestTargetNodeTypesResponse
    
    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

CreateIndex

CreateInstance

CreateLogstashInstance

DeleteIndex

DeleteInstance

DeleteLogstashInstance

DeleteLogstashPipelines

DescribeIndexList

DescribeIndexMeta

DescribeInstanceLogs

DescribeInstanceOperations

DescribeInstances

DescribeLogstashInstanceLogs

DescribeLogstashInstanceOperations

DescribeLogstashInstances

DescribeLogstashPipelines

DescribeViews

DiagnoseInstance

GetRequestTargetNodeTypes

RestartInstance

RestartKibana

RestartLogstashInstance

RestartNodes

SaveAndDeployLogstashPipeline

StartLogstashPipelines

StopLogstashPipelines

UpdateDiagnoseSettings

UpdateDictionaries

UpdateIndex

UpdateInstance

UpdateJdk

UpdateLogstashInstance

UpdateLogstashPipelineDesc

UpdatePlugins

UpdateRequestTargetNodeTypes

UpgradeInstance

UpgradeLicense