API Overview

CSS APIs comply with RESTful API design specifications. You can use the functions listed in Table 1 through calling APIs.

**Table 1** API description
Type	Description
Cluster Management APIs	These APIs are used to create clusters, scale out clusters, view cluster details, and obtain instance specifications.
Word Dictionary Management APIs	CSS provides the custom word dictionary function. With word dictionary management APIs, you can upload or delete the custom word dictionary and query status of the word dictionary.
Kibana Public Network Access APIs	These APIs are used to enable, disable, and modify Kibana public access for a cluster in security mode.
Log Management APIs	These APIs are used to enable, disable, modify, and query logs.
Public Network Access APIs	These APIs are used to enable, disable, and modify the public network access of 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 a snapshot.
VPC Endpoint APIs	These APIs can be used to enable, disable, obtain, and update VPC endpoint connections.
Parameter Configuration APIs	These APIs can be used to modify the parameter configurations of a cluster.

**Table 2** 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 clusters.
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.
Adding or Deleting Cluster Tags in Batches	This API is used to add tags to or delete tags from a cluster in batches.
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.
Removing Specified Nodes	This API is used to scale in a cluster by removing specified nodes.
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.
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.
Downloading a Security Certificate	This API is used to download a security certificate.
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.

**Table 3** Word dictionary management APIs
API	Description
Loading a Custom Word Dictionary	This API is used to load a custom word dictionary stored in OBS.
Querying the Status Of a Custom Word Dictionary	This API is used to query the loading status of a custom word dictionary.
Deleting a Custom Word Dictionary	This API is used to delete custom word dictionaries.

**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** Log management APIs
API	Description
Enabling the Log Function	This API is used to enable the log management function.
Disabling the Log Function	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 the Automatic Log Backup Policy	This API is used to enable the automatic log backup policy.
Disabling the Automatic Log Backup Policy	This API is used to disable the 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.

**Table 6** 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 7** 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.
Enabling Automatic Snapshot Creation	This API is used to enable the automatic snapshot creation function.
Disabling Automatic Snapshot Creation	This API is used to disable the automatic snapshot creation function.

**Table 8** 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 9** 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.