# API概览
CSS提供的接口为符合RESTful API设计规范的自研接口。通过CSS的自研接口，您可以使用CSS的如[表2]所示的功能。
![](https://support.huaweicloud.com/api-css/public_sys-resources/caution_3.0-zh-cn.png)
本服务已上线部分V2版本的API，请优先使用V2版本的API。
#### API V2
表1V2版本的接口说明 
| 类型                                                                                  | 说明                                                          |
|:---|:---|
| [创建集群V2](https://support.huaweicloud.com/api-css/CreateClusterMultiRole.html)       | 该接口用于创建拥有多种不同节点类型（ess，ess-cold，ess-client，ess-master）组合的集群。 |
| [重启集群V2](https://support.huaweicloud.com/api-css/RestartClusterMultiRole.html)      | 该接口可以用于重启当前集群拥有的全部节点类型，或部分节点类型组合的节点。                        |
| [滚动重启](https://support.huaweicloud.com/api-css/RollingRestart.html)                 | 该接口会一个一个重启节点，在索引数量比较多的情况下耗时较长                               |
| [开启自动创建快照功能](https://support.huaweicloud.com/api-css/StartAutoCreateSnapshots.html) | 该接口用于打开自动备份功能。                                              |
| [关闭自动创建快照功能](https://support.huaweicloud.com/api-css/StopAutoCreateSnapshots.html)  | 该接口用于关闭自动备份功能。                                              |
| [删除配置文件V2](https://support.huaweicloud.com/api-css/DeleteLogstashConf.html)         | 该接口用于删除配置文件。                                                |
| [删除自定义模板V2](https://support.huaweicloud.com/api-css/DeleteLogstashTemplate.html)    | 该接口用于删除自定义模板。                                               |
   
#### API V1
 表2V1版本的接口说明 
| 类型                                              | 说明                                           |
|:---|:---|
| [集群管理接口]      | 可以通过接口创建集群、扩容集群、查看集群详情、获取实例规格列表等。            |
| [规格查询接口]      | 可以通过接口获取实例规格信息。                              |
| [标签管理接口]    | 可以通过接口获取标签信息。                                |
| [形态变更接口]      | 可以通过接口进行形态变更操作。                              |
| [词库管理接口]      | 提供自定义词库功能，可以通过接口加载自定义库、查询词库状态或删除自定义词库。       |
| [Kibana公网访问接口] | Kibana公网访问功能支持通过接口进行开启、关闭、修改等操作。             |
| [Logstash接口] | 可以通过接口创建Logstash类型集群的配置文件、启动pipeline迁移数据等操作。 |
| [日志管理接口]       | 可以通过日志管理接口进行开启、关闭、修改、查询等操作。                  |
| [公网访问接口]     | 可以通过公网访问接口进行开启、关闭、修改等操作。                     |
| [快照管理接口]     | 快照功能可应用于数据备份与恢复，可以通过接口创建快照、恢复快照或者删除快照等。      |
| [终端节点接口]      | 可以通过终端节点接口进行开启、关闭、获取连接、更新连接等操作。              |
| [参数配置接口]       | 可以通过参数配置接口修改集群的参数配置。                         |
| [负载均衡接口]       | 可以通过负载均衡接口打开、关闭、获取负载均衡器信息。                   |
| [智能运维接口]     | 可以通过智能运维接口创建、删除、获取诊断任务。                      |
   
 表3集群管理接口 
| API                                                                                    | 说明                                                |
|:---|:---|
| [创建集群](https://support.huaweicloud.com/api-css/CreateCluster.html)                     | 该接口用于创建集群。                                        |
| [查询集群列表](https://support.huaweicloud.com/api-css/ListClustersDetails.html)             | 该接口用于查询并显示集群列表以及集群的状态。                            |
| [查询集群详情](https://support.huaweicloud.com/api-css/ShowClusterDetail.html)               | 该接口用于查询并显示单个集群详情。                                 |
| [删除集群](https://support.huaweicloud.com/api-css/DeleteCluster.html)                     | 此接口用于删除集群。                                        |
| [按需集群转包周期](https://support.huaweicloud.com/api-css/UpdateOndemandClusterToPeriod.html) | 该接口用于按需集群转包周期集群。                                  |
| [修改集群名称](https://support.huaweicloud.com/api-css/UpdateClusterName.html)               | 该接口用于修改集群名称。                                      |
| [修改密码](https://support.huaweicloud.com/api-css/ResetPassword.html)                     | 该接口用于修改集群密码。                                      |
| [更新集群路由](https://support.huaweicloud.com/api-css/UpdateRoute.html)                     | 该接口用于更新集群路由。                                      |
| [获取集群路由](https://support.huaweicloud.com/api-css/GetRoutes.html)                       | 该接口用于获取集群路由。                                      |
| [重启集群](https://support.huaweicloud.com/api-css/RestartCluster.html)                    | 此接口用于重启集群，重启集群将导致业务中断。                            |
| [下载安全证书](https://support.huaweicloud.com/api-css/DownloadCert.html)                    | 该接口用于下载安全证书。                                      |
| [集群内核升级](https://support.huaweicloud.com/api-css/UpgradeCore.html)                     | 该接口用于将低版本的ES升级到高版本或同版本ES。                         |
| [获取可升级的目标镜像ID](https://support.huaweicloud.com/api-css/ListImages.html)                | 该接口用于获取当前集群的可升级目标镜像ID。                            |
| [获取集群升级或切换AZ的详情信息](https://support.huaweicloud.com/api-css/UpgradeDetail.html)         | 由于升级过程时间较长，该接口可以展示当前集群升级或者切换AZ时，节点的各个阶段信息。        |
| [重试升级失败任务](https://support.huaweicloud.com/api-css/RetryUpgradeTask.html)              | 由于升级过程时间较长，可能由于网络等原因导致升级失败，可以通过该接口重试该任务或终止该任务的影响。 |
| [切换集群子网](https://support.huaweicloud.com/api-css/ChangeClusterSubnet.html)             | 该接口可以在集群创建成功后，切换集群子网，扩容等添加节点场景下使用新子网绑定新增节点。       |
| [切换集群实例AZ](https://support.huaweicloud.com/api-css/UpdateAzByInstanceType.html)        | 该接口通过指定节点类型切换可用区。                                 |
| [自动创建委托](https://support.huaweicloud.com/api-css/CreateAgency.html)                    | 该接口可以自动创建委托。                                      |
   
 表4规格查询接口 
| API                                                                                   | 说明                      |
|:---|:---|
| [获取实例规格列表](https://support.huaweicloud.com/api-css/ListFlavors.html)                  | 该接口用于查询并显示支持的实例规格对应的ID。 |
| [查询指定集群的可变更规格列表](https://support.huaweicloud.com/api-css/ShowResizeFlavors.html)      | 该接口用于查询指定集群可以变更到哪些规格。   |
| [查询规格详情](https://support.huaweicloud.com/api-css/ShowFlavorDetail.html)               | 该接口用于查询规格详细信息。          |
| [查询指定引擎支持的规格](https://support.huaweicloud.com/api-css/ShowDataStoreFlavorDetail.html) | 该接口用于查询指定引擎支持的规格。       |
   
 表5标签管理接口 
| API                                                                                 | 说明                       |
|:---|:---|
| [查询所有标签](https://support.huaweicloud.com/api-css/ListClustersTags.html)             | 该接口用于查询指定region下的所有标签集合。 |
| [查询指定集群的标签](https://support.huaweicloud.com/api-css/ShowClusterTag.html)            | 该接口用于查询指定集群的标签信息。        |
| [添加指定集群标签](https://support.huaweicloud.com/api-css/CreateClustersTags.html)         | 该接口用于给指定集群添加标签。          |
| [删除集群标签](https://support.huaweicloud.com/api-css/DeleteClustersTags.html)           | 此接口用于删除集群标签。             |
| [批量添加或删除集群标签](https://support.huaweicloud.com/api-css/UpdateBatchClustersTags.html) | 该接口用于对集群批量添加或删除标签。       |
   
 表6形态变更接口 
| API                                                                                      | 说明                                                    |
|:---|:---|
| [切换集群实例可用区](https://support.huaweicloud.com/api-css/UpdateAzByInstanceType.html)         | 该接口通过指定节点类型切换可用区。                                     |
| [指定节点类型规格变更](https://support.huaweicloud.com/api-css/UpdateFlavorByType.html)            | 修改集群规格。支持修改ess， ess-cold， ess-client， ess-master节点类型。 |
| [指定节点类型缩容](https://support.huaweicloud.com/api-css/UpdateShrinkCluster.html)             | 该接口用于集群缩容不同类型实例的个数以及存储容量。                             |
| [扩容集群](https://support.huaweicloud.com/api-css/UpdateExtendCluster.html)                 | 该接口用于集群扩容实例（仅支持扩容elasticsearch实例）。                    |
| [扩容实例的数量和存储容量](https://support.huaweicloud.com/api-css/UpdateExtendInstanceStorage.html) | 该接口用于集群扩容不同类型实例的个数以及存储容量。                             |
| [变更规格](https://support.huaweicloud.com/api-css/UpdateFlavor.html)                        | 该接口用于变更集群规格。                                          |
| [节点替换](https://support.huaweicloud.com/api-css/UpdateInstance.html)                      | 该接口用于替换失败节点。                                          |
| [安全模式修改](https://support.huaweicloud.com/api-css/ChangeMode.html)                        | 该接口用于切换集群的安全模式。                                       |
| [添加独立master、client](https://support.huaweicloud.com/api-css/AddIndependentNode.html)     | 该接口用于添加master或者client节点。                              |
   
 表7词库管理接口 
| API                                                                           | 说明                   |
|:---|:---|
| [加载自定义词库](https://support.huaweicloud.com/api-css/CreateLoadIkThesaurus.html) | 该接口用于加载存放于OBS的自定义词库。 |
| [查询自定义词库状态](https://support.huaweicloud.com/api-css/ShowIkThesaurus.html)     | 该接口用于查询自定义词库的加载状态。   |
| [删除自定义词库](https://support.huaweicloud.com/api-css/DeleteIkThesaurus.html)     | 该接口用于删除自定义词库。        |
   
 表8Kibana公网访问接口 
| API                                                                                        | 说明                              |
|:---|:---|
| [开启Kibana公网访问](https://support.huaweicloud.com/api-css/StartKibanaPublic.html)             | 该接口用于开启Kibana公网访问。              |
| [关闭Kibana公网访问](https://support.huaweicloud.com/api-css/UpdateCloseKibana.html)             | 该接口用于关闭Kibana公网访问。              |
| [修改Kibana公网带宽](https://support.huaweicloud.com/api-css/UpdateAlterKibana.html)             | 该接口用于修改Kibana公网带宽。              |
| [修改Kibana公网访问控制](https://support.huaweicloud.com/api-css/UpdatePublicKibanaWhitelist.html) | 该接口通过修改Kibana白名单，修改Kibana的访问权限。 |
| [关闭Kibana公网访问控制](https://support.huaweicloud.com/api-css/StopPublicKibanaWhitelist.html)   | 该接口用于关闭Kibana公网访问控制。            |
   
 表9Logstash接口 
| API                                                                              | 说明                                                                               |
|:---|:---|
| [创建配置文件](https://support.huaweicloud.com/api-css/CreateConf.html)                | 该接口用于创建配置文件。                                                                     |
| [更新配置文件](https://support.huaweicloud.com/api-css/UpdateConf.html)                | 该接口用于更新配置文件。                                                                     |
| [启动pipeline迁移数据](https://support.huaweicloud.com/api-css/StartPipeline.html)     | 该接口用于启动pipeline迁移数据。                                                             |
| [停止pipeline迁移数据](https://support.huaweicloud.com/api-css/StopPipeline.html)      | 该接口用于停止pipeline迁移数据。                                                             |
| [添加到自定义模板](https://support.huaweicloud.com/api-css/AddFavorite.html)             | 该接口用于添加到自定义模板。                                                                   |
| [查询pipeline列表](https://support.huaweicloud.com/api-css/ListPipelines.html)       | 该接口用于查询pipeline列表。                                                               |
| [查询配置文件列表](https://support.huaweicloud.com/api-css/ListConfs.html)               | 查询配置文件列表。                                                                        |
| [连通性测试](https://support.huaweicloud.com/api-css/StartConnectivityTest.html)      | 该接口用于连通性测试。                                                                      |
| [查询模板列表](https://support.huaweicloud.com/api-css/ListTemplates.html)             | 该接口用于查询模板列表。                                                                     |
| [查询操作记录](https://support.huaweicloud.com/api-css/ListActions.html)               | 该接口用于查询操作记录。                                                                     |
| [查询配置文件内容](https://support.huaweicloud.com/api-css/ShowGetConfDetail.html)       | 该接口用于查询配置文件内容。                                                                   |
| [删除配置文件](https://support.huaweicloud.com/api-css/DeleteConf.html)                | 删除配置文件。                                                                          |
| [删除自定义模板](https://support.huaweicloud.com/api-css/DeleteTemplate.html)           | 该接口用于删除自定义模板。                                                                    |
| [热启动pipeline迁移数据](https://support.huaweicloud.com/api-css/StartHotPipeline.html) | 该接口用于热启动pipeline迁移数据。                                                            |
| [热停止pipeline迁移数据](https://support.huaweicloud.com/api-css/StopHotPipeline.html)  | 该接口用于热停止pipeline迁移数据。                                                            |
| [上传证书文件](https://support.huaweicloud.com/api-css/UploadCerts.html)               | 该接口用于上传证书文件。                                                                     |
| [查询证书列表](https://support.huaweicloud.com/api-css/ListCerts.html)                 | 该接口用于查询证书列表。                                                                     |
| [查询证书文件信息](https://support.huaweicloud.com/api-css/ShowCertsDetail.html)         | 该接口用于查询证书文件信息。                                                                   |
| [删除证书文件](https://support.huaweicloud.com/api-css/DeleteCerts.html)               | 该接口用于删除证书文件。                                                                     |
| [强制重启集群VMs](https://support.huaweicloud.com/api-css/RebootCluster.html)          | 重启过程中集群不可用，请谨慎操作。 运行中状态的集群，重启过程会主动停止logstash进程，管道列表"是否保持常驻"值为否，会将所有运行中管道状态置为已停止。 |
   
 表10日志管理接口 
| API                                                                                      | 说明                      |
|:---|:---|
| [开启日志功能](https://support.huaweicloud.com/api-css/StartLogs.html)                         | 该接口用于开启日志管理功能。          |
| [关闭日志功能](https://support.huaweicloud.com/api-css/StopLogs.html)                          | 该接口用于关闭日志管理功能。          |
| [查询作业列表](https://support.huaweicloud.com/api-css/ListLogsJob.html)                       | 该接口用于查询具体某个集群的日志任务记录列表。 |
| [查询日志基础配置](https://support.huaweicloud.com/api-css/ShowGetLogSetting.html)               | 该接口用于日志基础配置查询。          |
| [修改日志基础配置](https://support.huaweicloud.com/api-css/UpdateLogSetting.html)                | 该接口用于修改日志基础配置。          |
| [开启日志自动备份策略](https://support.huaweicloud.com/api-css/StartLogAutoBackupPolicy.html)      | 该接口用于日志自动备份策略开启。        |
| [关闭日志自动备份策略](https://support.huaweicloud.com/api-css/StopLogAutoBackupPolicy.html)       | 该接口用于日志自动备份策略关闭。        |
| [备份日志](https://support.huaweicloud.com/api-css/CreateLogBackup.html)                     | 该接口用于备份日志。              |
| [查询日志](https://support.huaweicloud.com/api-css/ShowLogBackup.html)                       | 该接口用于查询日志信息。            |
| [连通性测试](https://support.huaweicloud.com/api-css/StartTargetClusterConnectivityTest.html) | 该接口用于两个集群之间的连通性测试。      |
   
 表11公网访问接口 
| API                                                                              | 说明                |
|:---|:---|
| [开启公网访问](https://support.huaweicloud.com/api-css/CreateBindPublic.html)          | 该接口用于开启公网访问。      |
| [关闭公网访问](https://support.huaweicloud.com/api-css/UpdateUnbindPublic.html)        | 该接口用于关闭公网访问。      |
| [修改公网访问带宽](https://support.huaweicloud.com/api-css/UpdatePublicBandWidth.html)   | 该接口用于修改公网访问带宽。    |
| [开启公网访问控制白名单](https://support.huaweicloud.com/api-css/StartPublicWhitelist.html) | 该接口用于开启公网访问控制白名单。 |
| [关闭公网访问控制白名单](https://support.huaweicloud.com/api-css/StopPublicWhitelist.html)  | 该接口用于关闭公网访问控制白名单。 |
   
 表12快照管理接口 
| API                                                                                   | 说明                                 |
|:---|:---|
| [自动设置集群快照的基础配置（不推荐使用）](https://support.huaweicloud.com/api-css/StartAutoSetting.html) | 该接口用于自动设置集群快照的基础配置，包括配置OBS桶和IAM委托。 |
| [修改集群快照的基础配置](https://support.huaweicloud.com/api-css/UpdateSnapshotSetting.html)     | 该接口用于修改集群快照的基础配置，可修改OBS桶和IAM委托。    |
| [手动创建快照](https://support.huaweicloud.com/api-css/CreateSnapshot.html)                 | 该接口用于手动创建一个快照。                     |
| [恢复快照](https://support.huaweicloud.com/api-css/RestoreSnapshot.html)                  | 该接口用于手动恢复一个快照。                     |
| [删除快照](https://support.huaweicloud.com/api-css/DeleteSnapshot.html)                   | 该接口用于删除快照。                         |
| [设置自动创建快照策略](https://support.huaweicloud.com/api-css/CreateAutoCreatePolicy.html)     | 该接口用于设置自动创建快照，默认一天创建一个快照。          |
| [查询自动创建快照的策略](https://support.huaweicloud.com/api-css/ShowAutoCreatePolicy.html)      | 该接口用于查询集群自动创建快照的策略。                |
| [查询快照列表](https://support.huaweicloud.com/api-css/ListSnapshots.html)                  | 该接口用于查询指定集群的快照列表。                  |
| [停用快照功能](https://support.huaweicloud.com/api-css/StopSnapshot.html)                   | 该接口用于停用快照功能。                       |
   
 表13终端节点接口 
| API                                                                              | 说明                 |
|:---|:---|
| [开启终端节点服务](https://support.huaweicloud.com/api-css/StartVpcep.html)              | 该接口用于开启终端节点服务。     |
| [关闭终端节点服务](https://support.huaweicloud.com/api-css/StopVpcep.html)               | 该接口用于关闭终端节点服务。     |
| [获取终端节点连接](https://support.huaweicloud.com/api-css/ShowVpcepConnection.html)     | 该接口用于获取终端节点连接。     |
| [更新终端节点连接](https://support.huaweicloud.com/api-css/UpdateVpcepConnection.html)   | 该接口用于更新终端节点连接。     |
| [修改终端节点服务白名单](https://support.huaweicloud.com/api-css/UpdateVpcepWhitelist.html) | 该接口用于修改终端节点服务访问控制。 |
   
 表14参数配置接口 
| API                                                                    | 说明                    |
|:---|:---|
| [修改参数配置](https://support.huaweicloud.com/api-css/UpdateYmls.html)      | 该接口用于修改参数配置。          |
| [获取参数配置任务列表](https://support.huaweicloud.com/api-css/ListYmlsJob.html) | 该接口可获取参数配置的任务列表。      |
| [获取参数配置列表](https://support.huaweicloud.com/api-css/ListYmls.html)      | 该接口用于获取当前集群现有的参数配置列表。 |
   
 表15负载均衡 
| API                                                                                      | 说明                                 |
|:---|:---|
| [查询集群支持的elbv3负载均衡器](https://support.huaweicloud.com/api-css/ListElbs.html)               | 展示查询集群支持的elbv3负载均衡器。               |
| [打开或关闭ES负载均衡器](https://support.huaweicloud.com/api-css/EnableOrDisableElb.html)          | 该接口打开或关闭ES负载均衡器。                   |
| [ES监听器配置](https://support.huaweicloud.com/api-css/CreateElbListener.html)                | 该接口用于ES监听器配置。                      |
| [获取该ESELB的信息，以及页面需要展示健康检查状态](https://support.huaweicloud.com/api-css/ShowElbDetail.html) | 该接口用于获取该ES集群的ELB信息，以及页面需要展示健康检查状态。 |
| [更新ES监听器](https://support.huaweicloud.com/api-css/UpdateESListener.html)                 | 该接口用于更新ES监听器。                      |
| [查询证书列表](https://support.huaweicloud.com/api-css/ListElbCerts.html)                      | 该接口用于查询证书列表。                       |
   
 表16智能运维 
| API                                                                            | 说明                     |
|:---|:---|
| [获取智能运维任务列表及详情](https://support.huaweicloud.com/api-css/ListAiOps.html)        | 该接口用于获取智能运维任务列表及详情。    |
| [创建一次集群检测任务](https://support.huaweicloud.com/api-css/CreateAiOps.html)         | 该接口用于创建一个集群检测任务。       |
| [删除一个检测任务记录](https://support.huaweicloud.com/api-css/DeleteAiOps.html)         | 该接口用于删除一个检测任务记录。       |
| [获取智能运维告警可用的SMN主题](https://support.huaweicloud.com/api-css/ListSmnTopics.html) | 该接口用于获取智能运维告警可用的SMN主题。 |