更新时间:2023-12-20 GMT+08:00

API概览

CSS提供的接口为符合RESTful API设计规范的自研接口。通过CSS的自研接口,您可以使用CSS的如表1所示的功能。

表1 接口说明

类型

说明

集群管理接口

可以通过接口创建集群、扩容集群、查看集群详情、获取实例规格列表等。

词库管理接口

云搜索服务提供自定义词库功能,可以通过接口加载自定义库、查询词库状态或删除自定义词库。

Kibana公网访问接口

Kibana公网访问功能支持通过接口进行开启、关闭、修改等操作。

日志管理接口

可以通过日志管理接口进行开启、关闭、修改、查询等操作。

公网访问接口

可以通过公网访问接口进行开启、关闭、修改等操作。

快照管理接口

快照功能可应用于数据备份与恢复,可以通过接口创建快照、恢复快照或者删除快照等。

终端节点接口

可以通过终端节点接口进行开启、关闭、获取连接、更新连接等操作。

参数配置接口

可以通过参数配置接口修改集群的参数配置。

表2 集群管理接口

API

说明

创建集群

该接口用于创建集群。

查询集群列表

该接口用于查询并显示集群列表以及集群的状态。

查询集群详情

该接口用于查询并显示单个集群详情。

删除集群

此接口用于删除集群。

按需集群转包周期

该接口用于按需集群转包周期集群。

修改集群名称

该接口用于修改集群名称。

修改密码

该接口用于修改集群密码。

重启集群

此接口用于重启集群,重启集群将导致业务中断。

扩容集群

该接口用于集群扩容实例(仅支持扩容elasticsearch实例)。

扩容实例的数量和存储容量

该接口用于集群扩容不同类型实例的个数以及存储容量。

变更规格

该接口用于变更集群规格。

获取实例规格列表

该接口用于查询并显示支持的实例规格对应的ID。

查询所有标签

该接口用于查询指定region下的所有标签集合。

查询指定集群的标签

该接口用于查询指定集群的标签信息。

添加指定集群标签

该接口用于给指定集群添加标签。

删除集群标签

此接口用于删除集群标签

批量添加或删除集群标签

该接口用于对集群批量添加或删除标签。

指定节点类型规格变更

修改集群规格。支持修改ess, ess-cold, ess-client, ess-master节点类型。

指定节点缩容

该接口可以对集群现有节点中指定节点进行缩容。

指定节点类型缩容

该接口用于集群缩容不同类型实例的个数以及存储容量。

节点替换

该接口用于替换失败节点。

切换安全组

该接口可以在集群创建成功后,修改安全组。

安全模式修改

该接口用于切换集群的安全模式。

添加独立master、client

该接口用于添加master或者client节点。

下载安全证书

该接口用于下载安全证书。

创建集群V2

该接口用于创建拥有多种不同节点类型(ess,ess-cold,ess-client,ess-master)组合的集群。

重启集群V2

该接口可以用于重启当前集群拥有的全部节点类型,或部分节点类型组合的节点。

滚动重启

该接口会一个一个重启节点,在索引数量比较多的情况下耗时较长

表3 词库管理接口

API

说明

加载自定义词库

该接口用于加载存放于OBS的自定义词库。

查询自定义词库状态

该接口用于查询自定义词库的加载状态。

删除自定义词库

该接口用于删除自定义词库。

表4 Kibana公网访问接口

API

说明

开启Kibana公网访问

该接口用于开启Kibana公网访问。

关闭Kibana公网访问

该接口用于关闭Kibana公网访问。

修改Kibana公网带宽

该接口用于修改Kibana公网带宽。

修改Kibana公网访问控制

该接口通过修改kibana白名单,修改kibana的访问权限。

关闭Kibana公网访问控制

该接口用于关闭Kibana公网访问控制。

表5 日志管理接口

API

说明

开启日志功能

该接口用于开启日志管理功能。

关闭日志功能

该接口用于关闭日志管理功能。

查询作业列表

该接口用于查询具体某个集群的日志任务记录列表。

查询日志基础配置

该接口用于日志基础配置查询。

修改日志基础配置

该接口用于修改日志基础配置。

开启日志自动备份策略

该接口用于日志自动备份策略开启。

关闭日志自动备份策略

该接口用于日志自动备份策略关闭。

备份日志

该接口用于备份日志。

查询日志

该接口用于查询日志信息。

表6 公网访问接口

API

说明

开启公网访问

该接口用于开启公网访问。

关闭公网访问

该接口用于关闭公网访问。

修改公网访问带宽

该接口用于修改公网访问带宽。

开启公网访问控制白名单

该接口用于开启公网访问控制白名单。

关闭公网访问控制白名单

该接口用于关闭公网访问控制白名单。

表7 快照管理接口

API

说明

自动设置集群快照的基础配置(不推荐使用)

该接口用于自动设置集群快照的基础配置,包括配置OBS桶和IAM委托。

修改集群快照的基础配置

该接口用于修改集群快照的基础配置,可修改OBS桶和IAM委托。

手动创建快照

该接口用于手动创建一个快照。

恢复快照

该接口用于手动恢复一个快照。

删除快照

该接口用于删除快照。

设置自动创建快照策略

该接口用于设置自动创建快照,默认一天创建一个快照。

查询自动创建快照的策略

该接口用于查询集群自动创建快照的策略。

查询快照列表

该接口用于查询指定集群的快照列表。

停用快照功能

该接口用于停用快照功能。

开启自动创建快照功能

该接口用于打开自动备份功能。

关闭自动创建快照功能

该接口用于关闭自动备份功能

表8 终端节点接口

API

说明

开启终端节点服务

该接口用于开启终端节点服务。

关闭终端节点服务

该接口用于关闭终端节点服务。

获取终端节点连接

该接口用于获取终端节点连接。

更新终端节点连接

该接口用于更新终端节点连接。

修改终端节点服务白名单

该接口用于修改终端节点服务访问控制。

表9 参数配置接口

API

说明

修改参数配置

该接口用于修改参数配置。

获取参数配置任务列表

该接口可获取参数配置的任务列表。

获取参数配置列表

该接口用于获取当前集群现有的参数配置列表。