更新时间:2023-11-09 GMT+08:00

创建OBS客户端

开发过程中,您有任何问题可以在github上提交issue接口参考文档详细介绍了每个接口的参数和使用方法。

OBS客户端(ObsClient)是访问OBS服务的Android客户端,它为调用者提供一系列与OBS服务进行交互的接口,用于管理、操作桶(Bucket)和对象(Object)等OBS服务上的资源。使用OBS Android SDK向OBS发起请求,您需要初始化一个ObsClient实例,并根据需要修改ObsConfiguration的默认配置项。

  • 直接使用服务地址创建OBS客户端(ObsClient),所有配置均为默认值,且后续不支持修改。示例代码如下:
    • 永久访问密钥(AK/SK)创建OBS客户端的代码如下:
      // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全;本示例以ak和sk保存在环境变量中为例,运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY_ID。
      // 您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/intl/zh-cn/usermanual-ca/ca_01_0003.html
      String ak = System.getenv("ACCESS_KEY_ID");
      String sk = System.getenv("SECRET_ACCESS_KEY_ID");
      String endPoint = "https://your-endpoint";
      // 创建ObsClient实例
      ObsClient obsClient = new ObsClient(ak, sk, endPoint);
       
      // 使用访问OBS
              
      // 关闭obsClient
      obsClient.close();
    • 临时访问密钥(AK/SK/SecurityToken)创建OBS客户端的代码如下:
      // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全;本示例以ak和sk保存在环境变量中为例,运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY_ID。
      // 您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/intl/zh-cn/usermanual-ca/ca_01_0003.html
      String ak = System.getenv("ACCESS_KEY_ID");
      String sk = System.getenv("SECRET_ACCESS_KEY_ID");
      String endPoint = "https://your-endpoint";
      String securityToken = "*** Provide your Security Token ***"; 
      // 创建ObsClient实例
      ObsClient obsClient = new ObsClient(ak, sk, securityToken, endPoint);
       
      // 使用访问OBS
              
      // 关闭obsClient
      obsClient.close();

OBS属于全局级服务,所以在获取临时访问密钥时,需要设置Token的使用范围取值为domain,表示获取的Token可以作用于全局服务,全局服务不区分项目或者区域。

  • 使用可定制各参数的配置类(ObsConfiguration)创建OBS客户端(ObsClient),创建完成后不支持再次修改参数,具体可配置的参数参见配置OBS客户端。示例代码如下:
// 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全;本示例以ak和sk保存在环境变量中为例,运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY_ID。
// 您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/intl/zh-cn/usermanual-ca/ca_01_0003.html
String ak = System.getenv("ACCESS_KEY_ID");
String sk = System.getenv("SECRET_ACCESS_KEY_ID");
String endPoint = "https://your-endpoint";
// 创建ObsConfiguration配置类实例
ObsConfiguration config = new ObsConfiguration();
config.setEndPoint(endPoint);
config.setSocketTimeout(30000);
config.setMaxErrorRetry(1);

// 创建ObsClient实例
ObsClient obsClient = new ObsClient(ak, sk, config);

// 使用访问OBS

// 关闭obsClient
obsClient.close();
  • 您的工程中可以有多个ObsClient,也可以只有一个ObsClient。
  • ObsClient是线程安全的,可在并发场景下使用。

ObsClient在调用ObsClient.close方法关闭后不能再次使用。