API Overview
CSS APIs comply with RESTful API design specifications. You can use the functions listed in Table 1 through calling APIs.
Type |
Description |
---|---|
These APIs are used to create clusters, scale out clusters, view cluster details, and obtain instance specifications. |
|
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. |
|
These APIs are used to enable, disable, and modify Kibana public access for a cluster in security mode. |
|
These APIs are used to enable, disable, modify, and query logs. |
|
These APIs are used to enable, disable, and modify the public network access of a cluster. |
|
Snapshots can be used to back up and restore data. You can use snapshot management APIs to create, restore, or delete a snapshot. |
|
These APIs can be used to enable, disable, obtain, and update VPC endpoint connections. |
|
These APIs can be used to modify the parameter configurations of a cluster. |
API |
Description |
---|---|
This API is used to create a cluster. |
|
This API is used to query and display the cluster list and cluster status. |
|
This API is used to query and display the details of a cluster. |
|
This API is used to delete clusters. |
|
This API is used to change the name of a cluster. |
|
This API is used to change the password of a cluster. |
|
This API is used to restart a cluster. Services will be interrupted during the restart. |
|
This API is used to add instances (Elasticsearch instances only) to a cluster. |
|
This API is used to add instances of different types and expand instance storage capacity in a cluster. |
|
This API is used to modify the specifications of a cluster. |
|
This API is used to query and display the IDs of supported instance specifications. |
|
This API is used to query all tags in a specified region. |
|
This API is used to query the tag information about a specified cluster. |
|
This API is used to add tags to a cluster. |
|
This API is used to delete the tags of a cluster. |
|
This API is used to add tags to or delete tags from a cluster in batches. |
|
This API is used to modify cluster specifications. Nodes of the ess, ess-cold, ess-client, and ess-master types can be modified. |
|
This API is used to scale in a cluster by removing specified nodes. |
|
This API is used to remove instances of different types and reduce instance storage capacity in a cluster. |
|
This API is used to replace a failed node. |
|
This API is used to switch the security mode of a cluster. |
|
This API is used to add a master or client node. |
|
This API is used to download a security certificate. |
|
This API is used to create a cluster with multiple node types (for example, ess, ess-cold, ess-client, and ess-master). |
|
This API is used to restart nodes of all node types or the combination of some node types in the current cluster. |
|
This API is used to restart nodes one by one, which requires a long time if the nodes have a large number of indexes. |
API |
Description |
---|---|
This API is used to load a custom word dictionary stored in OBS. |
|
This API is used to query the loading status of a custom word dictionary. |
|
This API is used to delete custom word dictionaries. |
API |
Description |
---|---|
This API is used to enable public network access to Kibana. |
|
This API is used to disable public network access to Kibana. |
|
This API is used to modify the public network bandwidth of Kibana. |
|
This API is used to modify the Kibana public network access whitelist. |
|
This API is used to disable the Kibana public network access whitelist. |
API |
Description |
---|---|
This API is used to enable the log management function. |
|
This API is used to disable the log management function. |
|
This API is used to query the job list in the logs of a cluster. |
|
This API is used to query basic log configurations. |
|
This API is used to modify basic log configurations. |
|
This API is used to enable the automatic log backup policy. |
|
This API is used to disable the automatic log backup policy. |
|
This API is used to back up logs. |
|
This API is used to query log information. |
API |
Description |
---|---|
This API is used to enable public network access. |
|
This API is used to disable public network access. |
|
This API is used to modify the public network access bandwidth. |
|
This API is used to enable the public network access control whitelist. |
|
This API is used to disable the public network access control whitelist. |
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. |
This API is used to modify the basic configurations of a cluster snapshot, including OBS buckets and IAM agency. |
|
This API is used to manually create a snapshot. |
|
This API is used to manually restore a snapshot. |
|
This API is used to delete a snapshot. |
|
This API is used to configure automatic snapshot creation. By default, a snapshot is created every day. |
|
This API is used to query the automatic snapshot creation policy of a cluster. |
|
This API is used to query the snapshot list of a specified cluster. |
|
This API is used to disable the snapshot function. |
|
This API is used to enable the automatic snapshot creation function. |
|
This API is used to disable the automatic snapshot creation function. |
API |
Description |
---|---|
This API is used to enable the VPC endpoint service. |
|
This API is used to disable the VPC endpoint service. |
|
This API is used to obtain a VPC endpoint connection. |
|
This API is used to update a VPC endpoint connection. |
|
This API is used to modify the endpoint service whitelist. |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot