Updated on 2024-12-02 GMT+08:00

API Overview

CSS APIs comply with RESTful API design specifications. You can use the functions listed in Table 1 by 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

These APIs are used to load, query, and delete OBS custom word dictionaries.

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

These APIs are used to create, restore, or delete snapshots. Snapshots are a convenient way to back up and restore data.

Parameter configuration APIs

These APIs can be used to modify the parameter configurations of a cluster.

Intelligent O&M APIs

These APIs are used to create, delete, and obtain intelligent O&M and detection tasks.