com.tencentcloudapi.es.v20180416

Class EsClient

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)

Method Summary

Modifier and Type	Method and Description
CreateIndexResponse	CreateIndex(CreateIndexRequest req) This API is used to create indices.
CreateInstanceResponse	CreateInstance(CreateInstanceRequest req) This API is used to create an ES cluster instance with the specified specification.
DeleteIndexResponse	DeleteIndex(DeleteIndexRequest req) This API is used to delete indices.
DeleteInstanceResponse	DeleteInstance(DeleteInstanceRequest req) This API is used to terminate a cluster instance.
DescribeIndexListResponse	DescribeIndexList(DescribeIndexListRequest req) This API is used to obtain the index list.
DescribeIndexMetaResponse	DescribeIndexMeta(DescribeIndexMetaRequest req) This API is used to obtain index metadata.
DescribeInstanceLogsResponse	DescribeInstanceLogs(DescribeInstanceLogsRequest req) This API is used to query the eligible ES cluster logs in the current region.
DescribeInstanceOperationsResponse	DescribeInstanceOperations(DescribeInstanceOperationsRequest req) This API is used to query the operation history of an instance by specified criteria.
DescribeInstancesResponse	DescribeInstances(DescribeInstancesRequest req) This API is used to query all eligible instances in the current region under the current account.
DescribeViewsResponse	DescribeViews(DescribeViewsRequest req) This API is used to query view data from three dimensions: cluster, node, and Kibana.
GetRequestTargetNodeTypesResponse	GetRequestTargetNodeTypes(GetRequestTargetNodeTypesRequest req) This API is used to get the node types used to receive client requests.
RestartInstanceResponse	RestartInstance(RestartInstanceRequest req) This API is used to restart an ES cluster instance (for operations such as system update).
RestartKibanaResponse	RestartKibana(RestartKibanaRequest req) This API is used to restart Kibana.
RestartNodesResponse	RestartNodes(RestartNodesRequest req) This API is used to restart cluster nodes.
UpdateDictionariesResponse	UpdateDictionaries(UpdateDictionariesRequest req) This API is used to update ES cluster dictionaries.
UpdateIndexResponse	UpdateIndex(UpdateIndexRequest req) This API is used to update indices.
UpdateInstanceResponse	UpdateInstance(UpdateInstanceRequest req) This API is used for operations such as modifying node specification, renaming an instance, modifying configuration, resetting password, and setting Kibana blocklist/allowlist.
UpdatePluginsResponse	UpdatePlugins(UpdatePluginsRequest req) This API is used to change the list of plugins.
UpdateRequestTargetNodeTypesResponse	UpdateRequestTargetNodeTypes(UpdateRequestTargetNodeTypesRequest req) This API is used to update the node types used to receive client requests.
UpgradeInstanceResponse	UpgradeInstance(UpgradeInstanceRequest req) This API is used to upgrade ES cluster version
UpgradeLicenseResponse	UpgradeLicense(UpgradeLicenseRequest req) This API is used to upgrade ES X-Pack.

Methods inherited from class com.tencentcloudapi.common.AbstractClient

call, callOctetStream, getClientProfile, getCredential, getRegion, getRegionBreaker, internalRequest, internalRequest, internalRequestRaw, processResponseJson, processResponseSSE, 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

This API is used to create indices.

Parameters:

req - CreateIndexRequest

Returns:

CreateIndexResponse

Throws:

TencentCloudSDKException

CreateInstance

public CreateInstanceResponse CreateInstance(CreateInstanceRequest req)
                                      throws TencentCloudSDKException

This API is used to create an ES cluster instance with the specified specification.

Parameters:

req - CreateInstanceRequest

Returns:

CreateInstanceResponse

Throws:

TencentCloudSDKException

DeleteIndex

public DeleteIndexResponse DeleteIndex(DeleteIndexRequest req)
                                throws TencentCloudSDKException

This API is used to delete indices.

Parameters:

req - DeleteIndexRequest

Returns:

DeleteIndexResponse

Throws:

TencentCloudSDKException

DeleteInstance

public DeleteInstanceResponse DeleteInstance(DeleteInstanceRequest req)
                                      throws TencentCloudSDKException

This API is used to terminate a cluster instance.

Parameters:

req - DeleteInstanceRequest

Returns:

DeleteInstanceResponse

Throws:

TencentCloudSDKException

DescribeIndexList

public DescribeIndexListResponse DescribeIndexList(DescribeIndexListRequest req)
                                            throws TencentCloudSDKException

This API is used to obtain the index list.

Parameters:

req - DescribeIndexListRequest

Returns:

DescribeIndexListResponse

Throws:

TencentCloudSDKException

DescribeIndexMeta

public DescribeIndexMetaResponse DescribeIndexMeta(DescribeIndexMetaRequest req)
                                            throws TencentCloudSDKException

This API is used to obtain index metadata.

Parameters:

req - DescribeIndexMetaRequest

Returns:

DescribeIndexMetaResponse

Throws:

TencentCloudSDKException

DescribeInstanceLogs

public DescribeInstanceLogsResponse DescribeInstanceLogs(DescribeInstanceLogsRequest req)
                                                  throws TencentCloudSDKException

This API is used to query the eligible ES cluster logs in the current region.

Parameters:

req - DescribeInstanceLogsRequest

Returns:

DescribeInstanceLogsResponse

Throws:

TencentCloudSDKException

DescribeInstanceOperations

public DescribeInstanceOperationsResponse DescribeInstanceOperations(DescribeInstanceOperationsRequest req)
                                                              throws TencentCloudSDKException

This API is used to query the operation history of an instance by specified criteria.

Parameters:

req - DescribeInstanceOperationsRequest

Returns:

DescribeInstanceOperationsResponse

Throws:

TencentCloudSDKException

DescribeInstances

public DescribeInstancesResponse DescribeInstances(DescribeInstancesRequest req)
                                            throws TencentCloudSDKException

This API is used to query all eligible instances in the current region under the current account.

Parameters:

req - DescribeInstancesRequest

Returns:

DescribeInstancesResponse

Throws:

TencentCloudSDKException

DescribeViews

public DescribeViewsResponse DescribeViews(DescribeViewsRequest req)
                                    throws TencentCloudSDKException

This API is used to query view data from three dimensions: cluster, node, and Kibana.

Parameters:

req - DescribeViewsRequest

Returns:

DescribeViewsResponse

Throws:

TencentCloudSDKException

GetRequestTargetNodeTypes

public GetRequestTargetNodeTypesResponse GetRequestTargetNodeTypes(GetRequestTargetNodeTypesRequest req)
                                                            throws TencentCloudSDKException

This API is used to get the node types used to receive client requests.

Parameters:

req - GetRequestTargetNodeTypesRequest

Returns:

GetRequestTargetNodeTypesResponse

Throws:

TencentCloudSDKException

RestartInstance

public RestartInstanceResponse RestartInstance(RestartInstanceRequest req)
                                        throws TencentCloudSDKException

This API is used to restart an ES cluster instance (for operations such as system update).

Parameters:

req - RestartInstanceRequest

Returns:

RestartInstanceResponse

Throws:

TencentCloudSDKException

RestartKibana

public RestartKibanaResponse RestartKibana(RestartKibanaRequest req)
                                    throws TencentCloudSDKException

This API is used to restart Kibana.

Parameters:

req - RestartKibanaRequest

Returns:

RestartKibanaResponse

Throws:

TencentCloudSDKException

RestartNodes

public RestartNodesResponse RestartNodes(RestartNodesRequest req)
                                  throws TencentCloudSDKException

This API is used to restart cluster nodes.

Parameters:

req - RestartNodesRequest

Returns:

RestartNodesResponse

Throws:

TencentCloudSDKException

UpdateDictionaries

public UpdateDictionariesResponse UpdateDictionaries(UpdateDictionariesRequest req)
                                              throws TencentCloudSDKException

This API is used to update ES cluster dictionaries.

Parameters:

req - UpdateDictionariesRequest

Returns:

UpdateDictionariesResponse

Throws:

TencentCloudSDKException

UpdateIndex

public UpdateIndexResponse UpdateIndex(UpdateIndexRequest req)
                                throws TencentCloudSDKException

This API is used to update indices.

Parameters:

req - UpdateIndexRequest

Returns:

UpdateIndexResponse

Throws:

TencentCloudSDKException

UpdateInstance

public UpdateInstanceResponse UpdateInstance(UpdateInstanceRequest req)
                                      throws TencentCloudSDKException

This API is used for operations such as modifying node specification, renaming an instance, modifying configuration, resetting password, and setting Kibana blocklist/allowlist. `InstanceId` is required, while `ForceRestart` is optional. Other parameters or parameter combinations and their meanings are as follows: - InstanceName: renames an instance (only for instance identification) - NodeInfoList: modifies node configuration (horizontally scaling nodes, vertically scaling nodes, adding primary nodes, adding cold nodes, etc.) - EsConfig: modifies cluster configuration - Password: changes the password of the default user "elastic" - EsAcl: modifies the ACL - CosBackUp: sets auto-backup to COS for a cluster Only one of the parameters or parameter combinations above can be passed in at a time, while passing fewer or more ones will cause the request to fail.

Parameters:

req - UpdateInstanceRequest

Returns:

UpdateInstanceResponse

Throws:

TencentCloudSDKException

UpdatePlugins

public UpdatePluginsResponse UpdatePlugins(UpdatePluginsRequest req)
                                    throws TencentCloudSDKException

This API is used to change the list of plugins.

Parameters:

req - UpdatePluginsRequest

Returns:

UpdatePluginsResponse

Throws:

TencentCloudSDKException

UpdateRequestTargetNodeTypes

public UpdateRequestTargetNodeTypesResponse UpdateRequestTargetNodeTypes(UpdateRequestTargetNodeTypesRequest req)
                                                                  throws TencentCloudSDKException

This API is used to update the node types used to receive client requests.

Parameters:

req - UpdateRequestTargetNodeTypesRequest

Returns:

UpdateRequestTargetNodeTypesResponse

Throws:

TencentCloudSDKException

UpgradeInstance

public UpgradeInstanceResponse UpgradeInstance(UpgradeInstanceRequest req)
                                        throws TencentCloudSDKException

This API is used to upgrade ES cluster version

Parameters:

req - UpgradeInstanceRequest

Returns:

UpgradeInstanceResponse

Throws:

TencentCloudSDKException

UpgradeLicense

public UpgradeLicenseResponse UpgradeLicense(UpgradeLicenseRequest req)
                                      throws TencentCloudSDKException

This API is used to upgrade ES X-Pack.

Parameters:

req - UpgradeLicenseRequest

Returns:

UpgradeLicenseResponse

Throws:

TencentCloudSDKException