Updated on 2026-09-03 GMT+08:00

API Overview

CSS APIs comply with RESTful API design specifications. You can use the functions described in Table 2 by calling the corresponding APIs.

Some APIs of V2 have been released. You are advised to use APIs of V2 preferentially.

**Table 1** Description of APIs of version V2
API	Description
Creating a Cluster (V2)	This API is used to create a cluster with multiple node types (for example, ess, ess-cold, ess-client, and ess-master).
Restarting a Cluster (V2)	This API is used to restart nodes of all node types or the combination of some node types in the current cluster.
Rolling Restart	This API is used to restart nodes one by one, which requires a long time if the nodes have a large number of indexes.
Enabling Automatic Snapshot Creation	This API is used to enable automatic snapshot creation.
Disabling Automatic Snapshot Creation	This API is used to disable automatic snapshot creation.
Deleting a Configuration File (V2)	This API is used to delete configuration files.
Deleting a Custom Template (V2)	This API is used to delete custom templates.

**Table 2** Description of APIs of version V1
API	Description
Cluster Management APIs	Create clusters, scale out clusters, view cluster details, and obtain instance specifications.
Log Management APIs	Enable, disable, modify, and query logs.
Snapshot Management APIs	Create, restore, and delete snapshots. Snapshots are a convenient way to back up and restore data.
Parameter Configuration APIs	Modify the parameter settings of a cluster.
Load Balancer APIs	Enable or disable load balancers, or obtain load balancer information.

**Table 3** Cluster management APIs
API	Description
Creating a Cluster	This API is used to create a cluster.
Querying the List of Clusters	This API is used to query and display the cluster list and cluster status.
Querying Cluster Details	This API is used to query and display the details of a cluster.
Deleting a Cluster	This API is used to delete a cluster.
Changing the Cluster Name	This API is used to change the name of a cluster.
Changing the Cluster Password	This API is used to change the password of a cluster.
Restarting a Cluster	This API is used to restart a cluster. Services will be interrupted during the restart.
Downloading a Security Certificate	This API is used to download a security certificate.
Obtaining Details About a Cluster Upgrade or AZ Switchover	An upgrade may take a long time. This API can be used to check phase-by-phase information during a cluster upgrade or AZ switchover.
Changing the AZ of a Cluster Instance	This API is used to change AZs by specifying node types.

**Table 4** Log management APIs
API	Description
Enabling the Log Function	This API is used to enable the log management function.
Disabling Logging	This API is used to disable the log management function.
Querying the Job List	This API is used to query the job list in the logs of a cluster.
Querying Basic Log Configurations	This API is used to query basic log configurations.
Modifying Basic Log Configurations	This API is used to modify basic log configurations.
Enabling an Automatic Log Backup Policy	This API is used to enable an automatic log backup policy.
Disabling an Automatic Log Backup Policy	This API is used to disable an automatic log backup policy.
Backing Up Logs	This API is used to back up logs.
Querying Logs	This API is used to query log information.
Testing Connectivity	This API is used to test the connectivity between two clusters.

**Table 5** Snapshot management APIs
API	Description
(Not Recommended) Automatically Configuring Basic Settings of a Cluster Snapshot	This API is used to automatically configure basic settings of a cluster snapshot, including configuring OBS buckets and IAM agency.
Modifying Basic Configurations of a Cluster Snapshot	This API is used to modify the basic configurations of a cluster snapshot, including OBS buckets and IAM agency.
Manually Creating a Snapshot	This API is used to manually create a snapshot.
Restoring a Snapshot	This API is used to manually restore a snapshot.
Deleting a Snapshot	This API is used to delete a snapshot.
Setting the Automatic Snapshot Creation Policy	This API is used to configure automatic snapshot creation. By default, a snapshot is created every day.
Querying the Automatic Snapshot Creation Policy	This API is used to query the automatic snapshot creation policy of a cluster.
Querying the Snapshot List	This API is used to query the snapshot list of a specified cluster.
Disabling the Snapshot Function	This API is used to disable the snapshot function.

**Table 6** Parameter configuration APIs
API	Description
Modifying Parameter Settings	This API is used to modify parameters.
Obtaining the Task List of Parameter Configurations	This API is used to obtain the task list of parameter configurations.
Obtaining the Parameter Configuration List	This API is used to obtain the parameter configuration list of the current cluster.

**Table 7** Load balancer APIs
API	Description
Querying ELB V3 Load Balancers Supported by a Cluster	This API is used to query the ELB V3 load balancers supported by a cluster.
Enabling or Disabling the Elasticsearch Load Balancer	This API is used to enable or disable an Elasticsearch load balancer.
Configuring an Elasticsearch Listener	This API is used to configure an Elasticsearch listener.
Obtaining Elasticsearch ELB Information and Health Check Status	This API is used to obtain the ELB information and health check status of an Elasticsearch cluster.
Updating an Elasticsearch Listener	This API is used to update an Elasticsearch listener.
Querying the Certificate List	This API is used to query the certificate list.