概述

本文档主要介绍百度智能云 Elasticsearch（BES）的 JAVA 语言版开发者工具包（SDK），用户可基于该 SDK 使用 JAVA 语言管理 BES 集群、索引、快照、插件、巡检等资源。SDK 封装了 BCE 签名认证、HTTP 通信和请求/响应模型，提供统一的错误码和返回格式，方便开发者调试。

BES Java SDK 随百度智能云 JAVA SDK（bce-java-sdk）一起发布，不需要单独安装。

客户端版本说明

BES Java SDK 提供三代客户端，接口路径和模型互不兼容，新接入请直接使用 BesClientV3。

客户端	所在包	接口数	说明
BesClientV3	com.baidubce.services.bes.v3	119	对应 BES v3 OpenAPI（/v3/...），功能覆盖最全，推荐使用
BesClientV2	com.baidubce.services.bes.v2	73	对应 BES v2 OpenAPI，为存量调用方保留
BesClient	com.baidubce.services.bes	15	早期客户端，仅覆盖 /api/bes/cluster 下的基础集群操作

bce-java-sdk 自 0.10.446 起提供 v2、v3 客户端；0.10.447 调整了 BES v2、v3 日志管理模型的包名，本文档以 0.10.447 为准。本文档介绍 BesClientV3 与 BesClientV2 两代客户端，早期的 BesClient 不再单独成文——它的 15 个方法都能在 BesClientV2 里找到对应实现（集群增删查改、启停、实例启停、续费与自动续费规则），存量代码可直接按同名方法迁移到 BesClientV2。

v3 接口覆盖范围

BesClientV3 按功能分为 13 类，具体分类如下：

分类	典型能力
集群管理	创建、查询、重命名、删除集群，查询节点与可用规格，下载证书
集群变更	变配、升级、启停、重启、节点迁移、公网访问与协议切换
索引管理	索引增删查改与批量操作、索引模板、ISM 生命周期策略
快照管理	手动/自动快照、快照恢复、恢复目标集群查询
智能巡检	自动与手动巡检开关、巡检项、巡检概览与报告
任务中心	变更任务（Action）与其子操作（Operation）的进度查询
日志管理	日志采集开关、用量、采集器状态、日志检索
插件管理	系统插件与自定义插件的查询、安装、删除，插件文件上传
计费管理	后付费转预付费、预付费转后付费、续费、询价
定时调度	定时任务的增删改查
用户管理	重置集群 admin 密码
控制面审计	云审计（BCT）授权开关与事件检索
数据面审计	集群数据面审计开关、事件类型与事件检索

v2 接口覆盖范围

BesClientV2 按功能分为 9 类，共 73 个接口：

分类	接口数	典型能力
集群	18	创建、查询、删除集群，启停与重启，重置密码，扩容与新增节点类型，EIP 绑定/解绑，HTTPS 开关，操作历史与数据量观测
实例	10	单个与批量启停实例、删除实例、缩容节点查询、数据迁移及其确认与回滚
智能巡检	13	巡检授权、自动巡检开关、手动巡检任务与配置、巡检项、巡检概况与任务结果
插件配置	9	系统默认插件与自定义插件的安装/卸载/删除、插件列表、自定义插件上传、NLP 词典查看与上传
自动续费	7	自动续费规则的增删改查、集群续费与续费列表
配置修改	5	集群配置查询与修改、同义词词典的列表/上传/删除
日志管理	4	日志设置、日志查询、日志导出任务的创建与记录查询
定时调度	4	定时调度任务的增删改查
标签	3	标签列表查询、批量新增标签、单集群标签更新

使用约定

• 所有接口都返回响应对象。 v3 不存在返回裸 Boolean 的接口，存在性检查返回 {exist} 形态的响应类，纯操作类接口返回 {success} 或带资源标识的响应类。v2 同样返回响应对象，大量操作类接口共用 CommonBesV2Response。
• 地域隔离。 集群数据、网络和资源按地域隔离，客户端需要同时指定正确的服务域名和地域，详见 BesClientV3、BesClientV2。
• 变更类接口是异步的。 v3 的变配、升级、启停等接口返回 actionId，需通过任务中心接口查询进度；v2 没有统一的任务中心，集群侧变更的进展通过「获取操作历史信息」查询。
• 两代客户端的接口路径完全不同。 v3 走 /v3/...，v2 走 /api/bes/cluster/...，请求模型也不共用，不能混用同一套 request 类。

相关文档

• 安装SDK工具包
• 快速入门
• BesClientV3
• BesClientV2