计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
弹性伸缩 AS
镜像服务 IMS
专属主机 DeH
函数工作流 FunctionGraph
云手机服务器 CPH
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
虚拟专用网络 VPN
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
VPC终端节点 VPCEP
云连接 CC
企业路由器 ER
企业交换机 ESW
全球加速 GA
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
边缘安全 EdgeSec
威胁检测服务 MTD
CDN与智能边缘
内容分发网络 CDN
CloudPond云服务
智能边缘云 IEC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
云搜索服务 CSS
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
数据可视化 DLV
数据湖工厂 DLF
湖仓构建 LakeFormation
企业应用
云桌面 Workspace
应用与数据集成平台 ROMA Connect
云解析服务 DNS
专属云
专属计算集群 DCC
IoT物联网
IoT物联网
设备接入 IoTDA
智能边缘平台 IEF
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
国际站常见问题
ICP备案
我的凭证
支持计划
客户运营能力
合作伙伴支持计划
专业服务
区块链
区块链服务 BCS
Web3节点引擎服务 NES
解决方案
SAP
高性能计算 HPC
视频
视频直播 Live
视频点播 VOD
媒体处理 MPC
实时音视频 SparkRTC
数字内容生产线 MetaStudio
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
存储容灾服务 SDRS
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属分布式存储服务 DSS
容器
云容器引擎 CCE
容器镜像服务 SWR
应用服务网格 ASM
华为云UCS
云容器实例 CCI
管理与监管
云监控服务 CES
统一身份认证服务 IAM
资源编排服务 RFS
云审计服务 CTS
标签管理服务 TMS
云日志服务 LTS
配置审计 Config
资源访问管理 RAM
消息通知服务 SMN
应用运维管理 AOM
应用性能管理 APM
组织 Organizations
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
应用身份管理服务 OneAccess
数据库
云数据库 RDS
文档数据库服务 DDS
数据管理服务 DAS
数据复制服务 DRS
云数据库 GeminiDB
云数据库 GaussDB
分布式数据库中间件 DDM
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
人脸识别服务 FRS
图引擎服务 GES
图像识别 Image
内容审核 Moderation
文字识别 OCR
AI开发平台ModelArts
图像搜索 ImageSearch
对话机器人服务 CBS
华为HiLens
视频智能分析服务 VIAS
语音交互服务 SIS
应用中间件
分布式缓存服务 DCS
API网关 APIG
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
多活高可用服务 MAS
事件网格 EG
企业协同
华为云会议 Meeting
云通信
消息&短信 MSGSMS
云生态
合作伙伴中心
云商店
开发者工具
SDK开发指南
API签名指南
Terraform
华为云命令行工具服务 KooCLI
其他
产品价格详情
系统权限
管理控制台
客户关联华为云合作伙伴须知
消息中心
公共问题
开发与运维
应用管理与运维平台 ServiceStage
软件开发生产线 CodeArts
需求管理 CodeArts Req
部署 CodeArts Deploy
性能测试 CodeArts PerfTest
编译构建 CodeArts Build
流水线 CodeArts Pipeline
制品仓库 CodeArts Artifact
测试计划 CodeArts TestPlan
代码检查 CodeArts Check
代码托管 CodeArts Repo
云应用引擎 CAE
开天aPaaS
云消息服务 KooMessage
云手机服务 KooPhone
云空间服务 KooDrive
本文导读

展开导读

API概览

更新时间:2025-01-22 GMT+08:00

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

表1 接口说明

类型

说明

集群管理接口

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

词库管理接口

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

Kibana公网访问接口

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

Logstash接口

可以通过接口创建Logstash类型集群的配置文件、启动pipeline迁移数据等操作。

日志管理接口

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

公网访问接口

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

快照管理接口

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

终端节点接口

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

参数配置接口

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

负载均衡接口

可以通过负载均衡接口打开、关闭、获取负载均衡器信息。

智能运维接口

可以通过智能运维接口创建、删除、获取检测任务。

表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 Logstash接口

API

说明

创建配置文件

该接口用于创建配置文件。

更新配置文件

该接口用于更新配置文件。

启动pipeline迁移数据

该接口用于启动pipeline迁移数据。

停止pipeline迁移数据

该接口用于停止pipeline迁移数据。

添加到自定义模板

该接口用于添加到自定义模板。

连通性测试

该接口用于连通性测试。

查询模板列表

该接口用于查询模板列表。

查询配置文件列表

查询配置文件列表。

查询pipeline列表

该接口用于查询pipeline列表。

查询操作记录

该接口用于查询操作记录。

查询配置文件内容

该接口用于查询配置文件内容。

删除配置文件

删除配置文件。

删除自定义模板

该接口用于删除自定义模板。

表6 日志管理接口

API

说明

开启日志功能

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

关闭日志功能

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

查询作业列表

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

查询日志基础配置

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

修改日志基础配置

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

开启日志自动备份策略

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

关闭日志自动备份策略

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

备份日志

该接口用于备份日志。

查询日志

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

表7 公网访问接口

API

说明

开启公网访问

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

关闭公网访问

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

修改公网访问带宽

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

开启公网访问控制白名单

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

关闭公网访问控制白名单

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

表8 快照管理接口

API

说明

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

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

修改集群快照的基础配置

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

手动创建快照

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

恢复快照

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

删除快照

该接口用于删除快照。

设置自动创建快照策略

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

查询自动创建快照的策略

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

查询快照列表

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

停用快照功能

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

开启自动创建快照功能

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

关闭自动创建快照功能

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

表9 终端节点接口

API

说明

开启终端节点服务

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

关闭终端节点服务

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

获取终端节点连接

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

更新终端节点连接

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

修改终端节点服务白名单

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

表10 参数配置接口

API

说明

修改参数配置

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

获取参数配置任务列表

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

获取参数配置列表

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

表11 负载均衡

API

说明

查询集群支持的elbv3负载均衡器

展示查询集群支持的elbv3负载均衡器。

打开或关闭ES负载均衡器

该接口打开或关闭ES负载均衡器。

ES监听器配置

该接口用于es监听器配置。

获取该esELB的信息,以及页面需要展示健康检查状态

该接口用于获取该ES集群的ELB信息,以及页面需要展示健康检查状态。

更新ES监听器

该接口用于更新ES监听器。

查询证书列表

该接口用于查询证书列表。

表12 智能运维

API

说明

获取智能运维任务列表及详情

该接口用于获取智能运维任务列表及详情。

创建一次集群检测任务

该接口用于创建一个集群检测任务。

删除一个检测任务记录

该接口用于删除一个检测任务记录。

获取智能运维告警可用的SMN主题

该接口用于获取智能运维告警可用的SMN主题。

我们使用cookie来确保您的高速浏览体验。继续浏览本站,即表示您同意我们使用cookie。 详情

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容