使用文档

更新时间：2026-07-01

本文档介绍百度智能云 GaiaDB 服务的 Java SDK 使用方法，涵盖客户端初始化及集群、接口、账号、数据库、快照备份、白名单、参数模板等全部功能接口。

准备工作

1.1 引入依赖

在项目中引入 bce-java-sdk 依赖（版本以实际发布为准）。

                XML
                
            

                <dependency>
    <groupId>com.baidubce</groupId>
    <artifactId>bce-java-sdk</artifactId>
    <version>x.x.x</version>
</dependency>
            

1.2 初始化客户端

GaiadbClient 是所有接口的入口，需要配置 Access Key、Secret Key 及服务 Endpoint。

                Java
                
            

                import com.baidubce.auth.DefaultBceCredentials;
import com.baidubce.services.gaiadb.GaiadbClient;
import com.baidubce.services.gaiadb.GaiadbClientConfiguration;

// 1. 构造配置
GaiadbClientConfiguration config = new GaiadbClientConfiguration();
config.setCredentials(new DefaultBceCredentials("your-access-key", "your-secret-key"));
config.setEndpoint("http://gaiadb.bj.baidubce.com");

// 2. 创建客户端
GaiadbClient client = new GaiadbClient(config);
            

说明：Endpoint 需根据集群所在区域填写，例如北京为 gaiadb.bj.baidubce.com。所有请求的基础路径为 /v1/gaiadb。

集群管理

2.1 创建集群

                Java
                
            

                ClusterCreateRequest request = new ClusterCreateRequest();
request.setProductType("prepay");   // 计费类型
request.setDuration(1);             // 购买时长
request.setNumber(1);               // 购买数量

ClusterCreateRequest.InstanceParam instanceParam = new ClusterCreateRequest.InstanceParam();
instanceParam.setReleaseVersion("8.0");
instanceParam.setAllocatedCpuInCore(2);
instanceParam.setAllocatedMemoryInGB(8);
instanceParam.setAllocatedStorageInGB(100);
instanceParam.setVpcId("vpc-xxxxxx");
instanceParam.setSubnetId("subnet-xxxxxx");
instanceParam.setAzone("cn-bj-a");
instanceParam.setClusterName("my-gaiadb-cluster");
request.setInstanceParam(instanceParam);

ClusterCreateResponse response = client.createCluster(request);
System.out.println(response);
            

2.2 查询集群列表

                Java
                
            

                // 查询全部集群
ClusterListResponse all = client.listClusters();

// 带过滤条件分页查询
ClusterListRequest listRequest = new ClusterListRequest();
listRequest.setMarker("marker-value");   // 分页游标
listRequest.setMaxKeys(20);              // 每页数量
listRequest.setClusterIpList("10.0.0.1");
listRequest.setClusterIds("gaiadb-xxxx");
ClusterListResponse list = client.listClusters(listRequest);
            

2.3 查询集群详情

                Java
                
                ClusterDetailResponse detail = client.getCluster("gaiadb-xxxxxx");

2.4 变配集群

                Java
                
            

                ClusterResizeRequest resizeRequest = new ClusterResizeRequest();
resizeRequest.setResizeType("resize");
resizeRequest.setAllocatedCpuInCore(4);
resizeRequest.setAllocatedMemoryInMB(16384);
OrderResponse order = client.resizeCluster("gaiadb-xxxxxx", resizeRequest);
            

2.5 续费集群

                Java
                
            

                RenewClusterRequest renewRequest = new RenewClusterRequest();
renewRequest.setInstanceId("gaiadb-xxxxxx");
renewRequest.setDuration(1);
renewRequest.setProductType("prepay");
OrderResponse order = client.renewCluster("gaiadb-xxxxxx", renewRequest);
            

2.6 删除集群

                Java
                
                client.deleteCluster("gaiadb-xxxxxx");

价格查询

3.1 查询创建集群价格

                Java
                
                ClusterCreateRequest request = new ClusterCreateRequest();
// ... 填充参数
PriceResponse price = client.getClusterPrice(request);

3.2 查询变配差价

                Java
                
                ClusterResizeRequest resizeRequest = new ClusterResizeRequest();
// ... 填充参数
PriceResponse diffPrice = client.getResizePrice(resizeRequest);

连接接口管理

4.1 查询接口列表

                Java
                
                GaiadbInterfaceListResponse interfaces = client.listInterfaces("gaiadb-xxxxxx");

4.2 更新接口配置

                Java
                
            

                GaiadbInterfaceUpdateRequest request = new GaiadbInterfaceUpdateRequest();
request.setInterfaceId("interface-xxxx");

GaiadbInterfaceUpdateRequest.InterfaceConfig cfg = new GaiadbInterfaceUpdateRequest.InterfaceConfig();
cfg.setAddressName("rw");
cfg.setMasterReadable(1);
cfg.setGlobalConsistency(1);
request.setInterfacee(cfg);

client.updateInterface("gaiadb-xxxxxx", request);
            

4.3 更新接口 DNS 名称

                Java
                
                GaiadbInterfaceUpdateDnsNameRequest request = new GaiadbInterfaceUpdateDnsNameRequest();
request.setInterfaceId("interface-xxxx");
request.setDnsName("my-dns-name");
client.updateInterfaceDnsName("gaiadb-xxxxxx", request);

账号管理

5.1 创建账号

                Java
                
            

                Account account = new Account();
account.setAccountName("app_user");
account.setPassword("YourPassword123");
account.setAccountType("common");
account.setRemark("应用账号");
client.createAccount("gaiadb-xxxxxx", account);
            

5.2 查询账号列表

                Java
                
                // 查询全部账号
AccountListResponse all = client.listAccounts("gaiadb-xxxxxx");

// 按类型查询
AccountListResponse admins = client.listAccounts("gaiadb-xxxxxx", "admin");

5.3 修改账号密码

                Java
                
                UpdateAccountPasswordRequest request = new UpdateAccountPasswordRequest();
request.setPassword("NewPassword123");
request.setEtag("etag-value");
client.updateAccountPassword("gaiadb-xxxxxx", "app_user", request);

5.4 修改账号权限

                Java
                
                AccountPrivilegesRequest request = new AccountPrivilegesRequest();
request.setEtag("etag-value");

Account.DatabasePrivilege dbPriv = new Account.DatabasePrivilege();
dbPriv.setDbName("mydb");
dbPriv.setAuthType("readWrite");
request.setDatabasePrivileges(java.util.Arrays.asList(dbPriv));

client.updateAccountPrivileges("gaiadb-xxxxxx", "app_user", request);

5.5 修改账号授权 IP

                Java
                
                UpdateAccountAuthIpRequest request = new UpdateAccountAuthIpRequest();
request.setAction("modify");
request.setEtag("etag-value");

Account.AuthValue value = new Account.AuthValue();
value.setAuthip(java.util.Arrays.asList("10.0.0.0/24"));
request.setValue(value);

client.updateAccountAuthIp("gaiadb-xxxxxx", "app_user", request);

5.6 删除账号

                Java
                
                client.deleteAccount("gaiadb-xxxxxx", "app_user");

数据库管理

6.1 创建数据库

                Java
                
            

                Database database = new Database();
database.setDbName("mydb");
database.setCharacterSetName("utf8mb4");
database.setRemark("业务库");
client.createDatabase("gaiadb-xxxxxx", database);
            

6.2 查询数据库列表

                Java
                
                DatabaseListResponse databases = client.listDatabases("gaiadb-xxxxxx");

6.3 删除数据库

                Java
                
                client.deleteDatabase("gaiadb-xxxxxx", "mydb");

快照与备份

7.1 创建快照

                Java
                
                // 使用默认参数创建快照
client.createSnapshot("gaiadb-xxxxxx");

// 指定备份类型
SnapshotCreateRequest request = new SnapshotCreateRequest();
request.setBackupType("full");
client.createSnapshot("gaiadb-xxxxxx", request);

7.2 查询快照列表

                Java
                
                SnapshotListResponse snapshots = client.listSnapshots("gaiadb-xxxxxx");

7.3 更新备份策略

                Java
                
            

                SnapshotPolicyUpdateRequest request = new SnapshotPolicyUpdateRequest();
request.setDataType("data");
request.setDataBackupWeekDay(java.util.Arrays.asList("Monday", "Thursday"));
request.setDataBackupTime("02:00:00");
request.setLogBackupRetainDays(7);
client.updateSnapshotPolicy("gaiadb-xxxxxx", request);
            

7.4 查询备份策略

                Java
                
                // 默认查询
SnapshotPolicyListResponse policy = client.getSnapshotPolicy("gaiadb-xxxxxx");

// 带过滤条件
SnapshotPolicyListRequest request = new SnapshotPolicyListRequest();
request.setDataType("data");
SnapshotPolicyListResponse result = client.getSnapshotPolicy("gaiadb-xxxxxx", request);

白名单管理

8.1 更新白名单

                Java
                
                WhitelistRequest request = new WhitelistRequest();
request.setAuthIps(java.util.Arrays.asList("10.0.0.0/24", "192.168.1.1"));
request.setEtag("etag-value");
client.updateWhitelist("gaiadb-xxxxxx", request);

8.2 查询白名单

                Java
                
                WhitelistResponse whitelist = client.getWhitelist("gaiadb-xxxxxx");

参数管理

9.1 查询参数

                Java
                
                ComputeModuleParamsResponse params = client.getComputeModuleParams("gaiadb-xxxxxx");

9.2 修改参数

                Java
                
                UpdateComputeModuleParamsRequest request = new UpdateComputeModuleParamsRequest();
request.setTiming("now");   // 生效时机

java.util.Map<String, String> paramMap = new java.util.HashMap<>();
paramMap.put("max_connections", "1000");
request.setParams(paramMap);

client.updateComputeModuleParams("gaiadb-xxxxxx", request);

异常处理

SDK 调用异常时会抛出 BceServiceException（服务端错误）或 BceClientException（客户端错误），建议统一捕获处理。

                Java
                
            

                import com.baidubce.BceServiceException;
import com.baidubce.BceClientException;

try {
    ClusterDetailResponse detail = client.getCluster("gaiadb-xxxxxx");
} catch (BceServiceException e) {
    System.out.println("Error code: " + e.getErrorCode());
    System.out.println("Error message: " + e.getErrorMessage());
    System.out.println("Request id: " + e.getRequestId());
} catch (BceClientException e) {
    System.out.println("Client error: " + e.getMessage());
}
            

评价此篇文章

有帮助没帮助

GO-SDK

性能白皮书

云原生数据库 GaiaDB