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.

APIs of V2

**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 Start	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.

APIs of V1

**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.
Kibana Public Network Access APIs	Enable, disable, and modify Kibana public network access for a security-mode cluster.
Logstash APIs	Create configuration files for Logstash clusters and start pipelines to migrate data.
Log Management APIs	Enable, disable, modify, and query logs.
Public Network Access APIs	Enable, disable, and modify public network access for a cluster.
Snapshot Management APIs	Snapshots can be used to back up and restore data. You can use snapshot management APIs to create, restore, or delete snapshots.
VPC Endpoint APIs	Enable, disable, obtain, and update VPC endpoint connections.
Parameter Configuration APIs	Modify the parameter settings of a cluster.
Load Balancer APIs	Enable or disable load balancers, or obtain load balancer information.
Intelligent O&M APIs	Create, delete, and obtain intelligent O&M and detection tasks.

**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 Billing Mode	This API is used to change the cluster billing mode from pay-per-use to yearly/monthly.
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.
Scaling Out a Cluster	This API is used to add instances (Elasticsearch instances only) to a cluster.
Adding Instances and Expanding Instance Storage Capacity	This API is used to add instances of different types and expand instance storage capacity in a cluster.
Changing Specifications	This API is used to modify the specifications of a cluster.
Obtaining the Instance Specifications List	This API is used to query and display the IDs of supported instance specifications.
Querying All Tags	This API is used to query all tags in a specified region.
Querying Tags of a Specified Cluster	This API is used to query the tag information about a specified cluster.
Adding Tags to a Cluster	This API is used to add tags to a cluster.
Deleting the Tags of a Cluster	This API is used to delete the tags of a cluster.
Updating Cluster Routes	This API is used to update cluster routes.
Adding or Deleting Cluster Tags in Batches	This API is used to add tags to or delete tags from a cluster in batches.
Obtaining a Cluster Route	This API is used to obtain a cluster route.
Removing Specified Nodes	This API is used to scale in a cluster by removing specified nodes.
Changing the Specifications of a Specified Node Type	This API is used to modify cluster specifications. Nodes of the ess, ess-cold, ess-client, and ess-master types can be modified.
Scaling In Nodes of a Specific Type	This API is used to remove instances of different types and reduce instance storage capacity in a cluster.
Downloading a Security Certificate	This API is used to download a security certificate.
Replacing a Node	This API is used to replace a failed node.
Modifying the Security Mode	This API is used to switch the security mode of a cluster.
Adding Master and Client Nodes	This API is used to add a master or client node.
Upgrading a Cluster Kernel	This API is used to upgrade Elasticsearch from an earlier version to a later version or the same version.
Obtaining the ID of the Target Image to Upgrade To	This API is used to obtain the ID of an image that the current cluster can be upgraded to.
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.
Retrying a Failed Upgrade Task	If an upgrade takes too long, there is a chance that it has already failed due to connectivity issues. You can call this API to retry the upgrade or terminate its impact.
Changing the Security Group	This API is used to change the security group after a cluster is created.
Changing the Subnet of a Cluster	This API is used to bind a new subnet to newly added nodes after cluster creation, or in the case of a cluster subnet change.
Changing the AZ of a Cluster Instance	This API is used to change AZs by specifying node types.

**Table 4** Kibana public network access APIs
API	Description
Enabling Kibana Public Access	This API is used to enable public network access to Kibana.
Disabling Kibana Public Access	This API is used to disable public network access to Kibana.
Modifying the Kibana Public Network Bandwidth	This API is used to modify the public network bandwidth of Kibana.
Modifying Kibana Public Network Access Control	This API is used to modify the Kibana public network access whitelist.
Disabling Kibana Public Network Access Control	This API is used to disable the Kibana public network access whitelist.

**Table 5** Logstash APIs
API	Description
Creating a Configuration File	This API is used to create the configuration file for a Logstash cluster.
Updating a Configuration File	This API is used to update the configuration file for a Logstash cluster.
Starting a Data Migration Pipeline	This API is used to start a data migration pipeline.
Stopping a Data Migration Pipeline	This API is used to stop a data migration pipeline.
Adding a Custom Template	This API is used to add a custom template.
Querying the Pipeline List	This API is used to query the pipeline list.
Querying the Configuration File List	This API is used to query the configuration file list.
Testing Connectivity	This API is used to test connectivity.
Querying the Template List	This API is used to query the template list.
Querying Operation Records	This API is used to query operation records.
Querying the Configuration File Content	This API is used to query the configuration file content.
Deleting a Configuration File	This API is used to delete a configuration file.
Deleting a Custom Template	This API is used to delete custom templates.
Hot-starting a Data Migration Pipeline	This API is used to hot-start a data migration pipeline.
Hot-stopping a Data Migration Pipeline	This API is used to hot-stop a data migration pipeline.
Uploading a Certificate	This API is used to upload a certificate.
Querying the Certificate List	This API is used to query the certificate list.
Querying Certificate Information	This API is used to query certificate information.
Deleting a Certificate	This API is used to delete a certificate.
Forcibly Restarting VMs in a Cluster	A cluster becomes unavailable during restart. Exercise caution. During the restart of a running cluster, the Logstash process is automatically stopped. If Keepalive is disabled for pipelines, restarting the cluster will stop all running pipelines.

**Table 6** 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 7** Public network access APIs
API	Description
Enabling Public Network Access	This API is used to enable public network access.
Disabling Public Network Access	This API is used to disable public network access.
Modifying Public Network Access Bandwidth	This API is used to modify the public network access bandwidth.
Enabling the Public Network Access Control Whitelist	This API is used to enable the public network access control whitelist.
Disabling the Public Network Access Control Whitelist	This API is used to disable the public network access control whitelist.

**Table 8** 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 9** VPC endpoint APIs
API	Description
Enabling the VPC Endpoint Service	This API is used to enable the VPC endpoint service.
Disabling the VPC Endpoint Service	This API is used to disable the VPC endpoint service.
Obtaining a VPC Endpoint Connection	This API is used to obtain a VPC endpoint connection.
Updating a VPC Endpoint Connection	This API is used to update a VPC endpoint connection.
Modifying the Endpoint Service Whitelist	This API is used to modify the endpoint service whitelist.

**Table 10** 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 11** 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.

**Table 12** Intelligent O&M APIs
API	Description
Obtaining the Intelligent O&M Task List and Details	This API is used to obtain the intelligent O&M task list and details.
Creating a Cluster Detection Task	This API is used to create a cluster detection task.
Deleting a Detection Task Record	This API is used to delete a detection task record.
Obtaining SMN Topics Available for Intelligent O&M Alarms	This API is used to obtain SMN topics available for intelligent O&M alarms.