API概览
CSS提供的接口为符合RESTful API设计规范的自研接口。通过CSS的自研接口，您可以使用CSS的如表2所示的功能。
本服务已上线部分V2版本的API，请优先使用V2版本的API。
API V2
|
类型 |
说明 |
|---|---|
|
该接口用于创建拥有多种不同节点类型（ess，ess-cold，ess-client，ess-master）组合的集群。 |
|
|
该接口可以用于重启当前集群拥有的全部节点类型，或部分节点类型组合的节点。 |
|
|
该接口会一个一个重启节点，在索引数量比较多的情况下耗时较长 |
|
|
该接口用于打开自动备份功能。 |
|
|
该接口用于关闭自动备份功能。 |
|
|
该接口用于删除配置文件。 |
|
|
该接口用于删除自定义模板。 |
|
|
该接口可用于获取集群的内网访问控制策略详情，包括访问控制策略类型和黑白名单网段信息。 |
|
|
该接口可用于修改集群的内网访问控制策略详情，包括调整内网访问控制策略和配置黑白名单网段。 |
API V1
|
类型 |
说明 |
|---|---|
|
可以通过接口创建集群、扩容集群、查看集群详情、获取实例规格列表等。 |
|
|
提供自定义词库功能，可以通过接口加载自定义库、查询词库状态或删除自定义词库。 |
|
|
Kibana公网访问功能支持通过接口进行开启、关闭、修改等操作。 |
|
|
可以通过接口创建Logstash类型集群的配置文件、启动pipeline迁移数据等操作。 |
|
|
可以通过日志管理接口进行开启、关闭、修改、查询等操作。 |
|
|
可以通过公网访问接口进行开启、关闭、修改等操作。 |
|
|
快照功能可应用于数据备份与恢复，可以通过接口创建快照、恢复快照或者删除快照等。 |
|
|
可以通过终端节点接口进行开启、关闭、获取连接、更新连接等操作。 |
|
|
可以通过参数配置接口修改集群的参数配置。 |
|
|
可以通过负载均衡接口打开、关闭、获取负载均衡器信息。 |
|
|
可以通过智能运维接口创建、删除、获取检测任务。 |
|
API |
说明 |
|---|---|
|
该接口用于创建集群。 |
|
|
该接口用于查询并显示集群列表以及集群的状态。 |
|
|
该接口用于查询并显示单个集群详情。 |
|
|
此接口用于删除集群。 |
|
|
该接口用于按需集群转包周期集群。 |
|
|
该接口用于修改集群名称。 |
|
|
该接口用于修改集群密码。 |
|
|
此接口用于重启集群，重启集群将导致业务中断。 |
|
|
该接口用于集群扩容实例（仅支持扩容elasticsearch实例）。 |
|
|
该接口用于集群扩容不同类型实例的个数以及存储容量。 |
|
|
该接口用于变更集群规格。 |
|
|
该接口用于查询并显示支持的实例规格对应的ID。 |
|
|
该接口用于查询指定region下的所有标签集合。 |
|
|
该接口用于查询指定集群的标签信息。 |
|
|
该接口用于给指定集群添加标签。 |
|
|
此接口用于删除集群标签。 |
|
|
该接口用于更新集群路由。 |
|
|
该接口用于对集群批量添加或删除标签。 |
|
|
该接口用于获取集群路由。 |
|
|
该接口可以对集群现有节点中指定节点进行缩容。 |
|
|
修改集群规格。支持修改ess， ess-cold， ess-client， ess-master节点类型。 |
|
|
该接口用于集群缩容不同类型实例的个数以及存储容量。 |
|
|
该接口用于下载安全证书。 |
|
|
该接口用于替换失败节点。 |
|
|
该接口用于切换集群的安全模式。 |
|
|
该接口用于添加master或者client节点。 |
|
|
该接口用于将低版本的ES升级到高版本或同版本ES。 |
|
|
该接口用于获取当前集群的可升级目标镜像ID。 |
|
|
由于升级过程时间较长，该接口可以展示当前集群升级或者切换AZ时，节点的各个阶段信息。 |
|
|
由于升级过程时间较长，可能由于网络等原因导致升级失败，可以通过该接口重试该任务或终止该任务的影响。 |
|
|
该接口可以在集群创建成功后，修改安全组。 |
|
|
该接口可以在集群创建成功后，切换集群子网，扩容等添加节点场景下使用新子网绑定新增节点。 |
|
|
该接口通过指定节点类型切换可用区。 |
|
API |
说明 |
|---|---|
|
该接口用于开启Kibana公网访问。 |
|
|
该接口用于关闭Kibana公网访问。 |
|
|
该接口用于修改Kibana公网带宽。 |
|
|
该接口通过修改kibana白名单，修改kibana的访问权限。 |
|
|
该接口用于关闭Kibana公网访问控制。 |
|
API |
说明 |
|---|---|
|
该接口用于创建配置文件。 |
|
|
该接口用于更新配置文件。 |
|
|
该接口用于启动pipeline迁移数据。 |
|
|
该接口用于停止pipeline迁移数据。 |
|
|
该接口用于添加到自定义模板。 |
|
|
该接口用于查询pipeline列表。 |
|
|
查询配置文件列表。 |
|
|
该接口用于连通性测试。 |
|
|
该接口用于查询模板列表。 |
|
|
该接口用于查询操作记录。 |
|
|
该接口用于查询配置文件内容。 |
|
|
删除配置文件。 |
|
|
该接口用于删除自定义模板。 |
|
|
该接口用于热启动pipeline迁移数据。 |
|
|
该接口用于热停止pipeline迁移数据。 |
|
|
该接口用于上传证书文件。 |
|
|
该接口用于查询证书列表。 |
|
|
该接口用于查询证书文件信息。 |
|
|
该接口用于删除证书文件。 |
|
|
重启过程中集群不可用，请谨慎操作。 工作中状态的集群，重启过程会主动停止logstash进程，管道列表“是否保持常驻”值为否，会将所有运行中管道状态置为已停止。 |
|
API |
说明 |
|---|---|
|
该接口用于开启日志管理功能。 |
|
|
该接口用于关闭日志管理功能。 |
|
|
该接口用于查询具体某个集群的日志任务记录列表。 |
|
|
该接口用于日志基础配置查询。 |
|
|
该接口用于修改日志基础配置。 |
|
|
该接口用于日志自动备份策略开启。 |
|
|
该接口用于日志自动备份策略关闭。 |
|
|
该接口用于备份日志。 |
|
|
该接口用于查询日志信息。 |
|
|
该接口用于两个集群之间的连通性测试。 |
|
API |
说明 |
|---|---|
|
该接口用于自动设置集群快照的基础配置，包括配置OBS桶和IAM委托。 |
|
|
该接口用于修改集群快照的基础配置，可修改OBS桶和IAM委托。 |
|
|
该接口用于手动创建一个快照。 |
|
|
该接口用于手动恢复一个快照。 |
|
|
该接口用于删除快照。 |
|
|
该接口用于设置自动创建快照，默认一天创建一个快照。 |
|
|
该接口用于查询集群自动创建快照的策略。 |
|
|
该接口用于查询指定集群的快照列表。 |
|
|
该接口用于停用快照功能。 |
|
API |
说明 |
|---|---|
|
展示查询集群支持的elbv3负载均衡器。 |
|
|
该接口打开或关闭ES负载均衡器。 |
|
|
该接口用于es监听器配置。 |
|
|
该接口用于获取该ES集群的ELB信息，以及页面需要展示健康检查状态。 |
|
|
该接口用于更新ES监听器。 |
|
|
该接口用于查询证书列表。 |
