配置自定义 域名 访问obs 使用自定义的域名，必须在工信部完成备案，具体配置步骤请参考：配置自定义域名。 // 在控制台绑定成功的自定义域名。 String endPoint = "http://your-domain"; // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量AC CES S_KEY_ID和SECRET_ACCESS_KEY_ID。 // 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html String ak = System.getenv("ACCESS_KEY_ID"); String sk = System.getenv("SECRET_ACCESS_KEY_ID"); // 创建ObsConfiguration配置类实例 ObsConfiguration config = new ObsConfiguration(); config.setEndPoint(endPoint); config.setCname(true); // 创建ObsClient实例 ObsClient obsClient = new ObsClient(ak, sk, config); // 使用Provider创建ObsClient实例 // ObsClient obsClient = new ObsClient(new EnvironmentVariableObsCredentialsProvider(), config); // ObsClient obsClient = new ObsClient(new EcsObsCredentialsProvider(), config); // 使用访问OBS // 关闭obsClient obsClient.close();

ObsConfiguration类支持配置的参数列表 如需提高文件上传下载性能，在网络带宽满足的情况下，可对socketWriteBufferSize，sockeReadBufferSize，readBufferSize，writeBufferSize四个参数进行调优。 如网络状况不佳，建议增大connectionTimeout和socketTimeout的值。 表2 ObsConfiguration类支持配置的参数列表 参数 描述 方法 建议值 connectionTimeout 参数解释： 建立HTTP/HTTPS连接的超时时间。 默认取值： 60000，单位：毫秒。 ObsConfiguration.setConnectionTimeout [10000, 60000] socketTimeout 参数解释： Socket层传输数据的超时时间（单位：毫秒）。 默认取值： 60000，单位：毫秒。 ObsConfiguration.setSocketTimeout [10000, 60000] idleConnectionTime 参数解释： 如果空闲时间超过此参数的设定值，则关闭连接。 默认取值： 30000，单位：毫秒。 ObsConfiguration.setIdleConnectionTime 根据实际情况设置 maxIdleConnections 参数解释： 连接池中最大空闲连接数。 默认取值： 1000，单位：个。 ObsConfiguration.setMaxIdleConnections 根据实际情况设置 maxConnections 参数解释： 最大允许的HTTP并发请求数。 默认取值： 1000，单位：个。 ObsConfiguration.setMaxConnections 默认 maxErrorRetry 参数解释： 请求失败（请求异常、服务端报500或503错误等）后最大的重试次数。 约束限制： 该参数对于上传对象和下载对象接口时，当上传或下载已经进入数据流处理阶段后产生异常中断，此时将不会重试。 默认取值： 3，单位：次。 ObsConfiguration.setMaxErrorRetry [0, 5] endPoint 参数解释： 连接OBS的服务地址。可包含协议类型、域名、端口号。示例：https://your-endpoint:443。（出于安全性考虑，建议使用https协议） 约束限制： 出于DNS解析性能和OBS服务可靠性的考虑，不允许将endPoint设置为IP，必须使用域名访问OBS服务，同时endpoint设置为IP还会导致使用path请求方式访问OBS桶，此方式已经禁止使用。（请在这个页面搜索并查看”禁止使用path请求方式访问OBS桶“相关说明）。 默认取值： 无 ObsConfiguration.setEndPoint 根据实际情况设置 httpProxy 参数解释： HTTP代理配置。 默认取值： 默认为空 ObsConfiguration.setHttpProxy 根据实际情况设置 validateCertificate 参数解释： 是否验证服务端证书。 取值范围： true：验证服务端证书。 false：不验证服务端证书。 默认取值： false ObsConfiguration.setValidateCertificate 根据实际情况设置 verifyResponseContentType 参数解释： 是否验证响应头信息的ContentType。 取值范围： true：验证响应头信息的ContentType。 false：不验证响应头信息的ContentType。 默认取值： true ObsConfiguration.setVerifyResponseContentType 默认 readBufferSize 参数解释： 从Socket流下载对象的缓存大小，-1表示不设置缓存。 默认取值： -1，单位：字节。 ObsConfiguration.setReadBufferSize 根据实际情况设置 writeBufferSize 参数解释： 上传对象到Socket流时的缓存大小，-1表示不设置缓存。 默认取值： -1，单位：字节。 ObsConfiguration.setWriteBufferSize 根据实际情况设置 socketWriteBufferSize 参数解释： Socket发送缓冲区大小，对应java.net.SocketOptions.SO_SNDBUF参数。 默认取值： 默认为-1，单位：字节，表示不设置。 ObsConfiguration.setSocketWriteBufferSize 默认 socketReadBufferSize 参数解释： Socket接收缓冲区大小，对应java.net.SocketOptions.SO_RCVBUF参数。 默认取值： 默认为-1，单位：字节，表示不设置。 ObsConfiguration.setSocketReadBufferSize 默认 keyManagerFactory 参数解释： 用于生成javax.net.ssl.KeyManager的工厂。 默认取值： 默认为空。 ObsConfiguration.setKeyManagerFactory 根据实际情况设置 trustManagerFactory 参数解释： 用于生成javax.net.ssl.TrustManager的工厂。 默认取值： 默认为空。 ObsConfiguration.setTrustManagerFactory 根据实际情况设置 isStrictHostnameVerification 参数解释： 是否严格验证服务端主机名。设置为true后，需要通过javax.net.ssl.HttpsURLConnection.setDefaultHostnameVerifier去设置一个实现javax.net.ssl.HostnameVerifier接口的对象，用于验证主机名 取值范围： true：严格验证服务端主机名。 false：不严格验证服务端主机名。 默认取值： false ObsConfiguration.setIsStrictHostnameVerification 根据实际情况设置 keepAlive 参数解释： 是否使用长连接访问OBS服务。 取值范围： true：使用长连接访问OBS服务。 false：不使用长连接访问OBS服务。 默认取值： true ObsConfiguration.setKeepAlive 根据实际情况设置 cname 参数解释： 是否通过自定义域名访问OBS服务。 取值范围： true：通过自定义域名访问OBS服务。 false：不通过自定义域名访问OBS服务。 默认取值： false ObsConfiguration.setCname 根据实际情况设置 sslProvider 参数解释： SSLContext的Provider。 默认取值： 使用JDK提供的SSLContext。 ObsConfiguration.setSslProvider 根据实际情况设置 httpProtocolType 参数解释： 访问OBS服务端时使用的HTTP协议类型。 默认取值： HTTP1.1 说明： 如果设置的endPoint不带协议类型，则默认使用HTTPS协议。 ObsConfiguration.setHttpProtocolType 根据实际情况设置 httpDispatcher 参数解释： 自定义分发器。 默认取值： 无 ObsConfiguration.setHttpDispatcher 根据实际情况设置 secureRandom 参数解释： 配置随机数生成器，支持设置为自定义的随机数生成器。 默认取值： 默认为 new SecureRandom() 说明： 在某些平台上new SecureRandom()可能会使用不安全实现。出于安全考虑，建议通过ObsConfiguration.setSecureRandom()设置一个种子是真随机数的SecureRandom。 当操作系统没有足够的熵来生成随机数时（比如系统刚启动时），那么生成真随机数的SecureRandom可能会阻塞，直到足够的熵可用为止。建议同时通过相关措施补充熵（例如linux下的haveged），改善熵源不足时生成真随机数阻塞的问题。 ObsConfiguration.setSecureRandom 根据实际情况设置

示例代码 使用不透传访问凭证的客户端类，直接配置访问凭证，除访问凭证外只配置终端节点（endpoint）的示例代码 永久访问密钥（AK/SK）创建OBS客户端的代码如下: 1 2 3 4 5 6 7 8 9 10 11 12 13 // Endpoint以北京四为例，其他地区请按实际情况填写。 String endPoint = "https://obs.cn-north-4.myhuaweicloud.com"; // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY_ID。 // 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html String ak = System.getenv("ACCESS_KEY_ID"); String sk = System.getenv("SECRET_ACCESS_KEY_ID"); // 创建ObsClient实例 ObsClient obsClient = new ObsClient(ak, sk, endPoint); // 使用访问OBS // 关闭obsClient obsClient.close(); 临时访问密钥（AK/SK/SecurityToken）创建OBS客户端的代码如下： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 // Endpoint以北京四为例，其他地区请按实际情况填写。 String endPoint = "https://obs.cn-north-4.myhuaweicloud.com"; // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY_ID。 // 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html String ak = System.getenv("ACCESS_KEY_ID"); String sk = System.getenv("SECRET_ACCESS_KEY_ID"); String securityToken = System.getenv("SECRET_TOKEN"); // 创建ObsClient实例 ObsClient obsClient = new ObsClient(ak, sk, securityToken, endPoint); // 使用访问OBS // 关闭obsClient obsClient.close(); BasicObsCredentialsProvider示例代码 1 2 3 4 5 6 7 8 9 10 11 12 13 // Endpoint以北京四为例，其他地区请按实际情况填写。 String endPoint = "https://obs.cn-north-4.myhuaweicloud.com"; // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY_ID。 // 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html String ak = System.getenv("ACCESS_KEY_ID"); String sk = System.getenv("SECRET_ACCESS_KEY_ID"); // 创建ObsClient实例 ObsClient obsClient = new ObsClient(new BasicObsCredentialsProvider(ak, sk), endPoint); // 使用访问OBS // 关闭obsClient obsClient.close(); 透传密钥客户端类（SecretFlexibleObsClient）示例代码 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 // Endpoint以北京四为例，其他地区请按实际情况填写。 String endPoint = "https://obs.cn-north-4.myhuaweicloud.com"; // 创建ObsConfiguration配置类实例 ObsConfiguration config = new ObsConfiguration(); config.setEndPoint(endPoint); // 创建SecretFlexibleObsClient实例 SecretFlexibleObsClient obsClient = new SecretFlexibleObsClient(config); // 使用访问OBS // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY_ID。 // 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html String ak1 = System.getenv("ACCESS_KEY_ID"); String sk1 = System.getenv("SECRET_ACCESS_KEY_ID"); obsClient.listBuckets(ak1, sk1); String ak2 = System.getenv("ACCESS_KEY_ID"); String sk2 = System.getenv("SECRET_ACCESS_KEY_ID"); obsClient.listBuckets(ak2, sk2); // 关闭obsClient obsClient.close(); 从环境变量获取访问凭证（EnvironmentVariableObsCredentialsProvider）示例代码 使用该方法需要在环境变量中定义OBS_ACCESS_KEY_ID和OBS_SECRET_ACCESS_KEY分别代表永久的AK和SK。 1 2 3 4 5 6 7 8 9 // Endpoint以北京四为例，其他地区请按实际情况填写。 String endPoint = "https://obs.cn-north-4.myhuaweicloud.com"; // 创建ObsClient实例 ObsClient obsClient = new ObsClient(new EnvironmentVariableObsCredentialsProvider(), endPoint); // 使用访问OBS // 关闭obsClient obsClient.close(); E CS 场景从云服务委托获取访问凭证（EcsObsCredentialsProvider）示例代码 1 2 3 4 5 6 7 8 9 // Endpoint以北京四为例，其他地区请按实际情况填写。 String endPoint = "https://obs.cn-north-4.myhuaweicloud.com"; // 创建ObsClient实例 ObsClient obsClient = new ObsClient(new EcsObsCredentialsProvider(), endPoint); // 使用访问OBS // 关闭obsClient obsClient.close(); 链式获取访问凭证（OBSCredentialsProviderChain）示例代码 1 2 3 4 5 6 7 8 9 // Endpoint以北京四为例，其他地区请按实际情况填写。 String endPoint = "https://obs.cn-north-4.myhuaweicloud.com"; // 创建ObsClient实例 ObsClient obsClient = new ObsClient(new OBSCredentialsProviderChain(), endPoint); // 使用访问OBS // 关闭obsClient obsClient.close(); 使用ObsConfiguration配置参数示例代码 配置KeyManagerFactory，配置后可以在本地保存证书，并校验服务端返回证书是否正确。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 // Endpoint以北京四为例，其他地区请按实际情况填写。 String endPoint = "https://obs.cn-north-4.myhuaweicloud.com"; // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY_ID。 // 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html String ak = System.getenv("ACCESS_KEY_ID"); String sk = System.getenv("SECRET_ACCESS_KEY_ID"); String jksPassword = "you-jks-password"; String jksPath = "/path/to/your/keystore/file"; KeyStore ks = KeyStore.getInstance("JKS"); char[] passArray = jksPassword.toCharArray(); FileInputStream inputStream = new FileInputStream(jksPath); ks.load(inputStream, passArray); KeyManagerFactory kmf = KeyManagerFactory.getInstance(KeyManagerFactory.getDefaultAlgorithm()); kmf.init(ks, passArray); String trustJKSPassword = "you-trustJKS-password"; String trustJKSPath = "/path/to/your/trustKeyStore/file"; KeyStore trustKeyStore = KeyStore.getInstance("JKS"); char[] trustPassArray = trustJKSPassword.toCharArray(); FileInputStream trustInputStream = new FileInputStream(trustJKSPath); trustKeyStore.load(trustInputStream, trustPassArray); TrustManagerFactory tmf = TrustManagerFactory.getInstance(TrustManagerFactory.getDefaultAlgorithm()); tmf.init(trustKeyStore); ObsConfiguration config = new ObsConfiguration(); config.setEndPoint(endPoint); config.setKeyManagerFactory(kmf); config.setTrustManagerFactory(tmf); ObsClient obsClient = new ObsClient(ak, sk, config); 本地证书保存格式应为 jks 格式，可以运行以下命令调用 Java 自带的 keytool 工具将 cer 证书转换为 jks 证书。 keytool -import -file your-cer-file.cer -keystore your-keystore-file.jks 配置 HTTP 代理，配置后SDK 将会通过的代理访问服务端。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 // Endpoint以北京四为例，其他地区请按实际情况填写。 String endPoint = "https://obs.cn-north-4.myhuaweicloud.com"; // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY_ID。 // 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html String ak = System.getenv("ACCESS_KEY_ID"); String sk = System.getenv("SECRET_ACCESS_KEY_ID"); // Url不要携带协议头"http://"和"https://"。 String proxyUrl = "proxy.com"; int proxyPort = 8080; String proxyUser = "userName"; String proxyPassword = "password"; ObsConfiguration config = new ObsConfiguration(); config.setEndPoint(endPoint); config.setHttpProxy(proxyUrl, proxyPort, proxyUser, proxyPassword); ObsClient obsClient = new ObsClient(ak, sk,config);

配置概览 图1 创建并配置客户端概览 如图所示，请根据需要选择客户端类、选择获取访问密钥的方法，以及进行其他配置： 表1 创建并配置客户端概览 选择项 可选项 说明 示例代码 客户端类 不透传密钥的客户端类 如果您只想配置一次访问凭证，不想在每一次调用OBS接口时都为客户端设置一次访问密钥，请使用普通客户端类ObsClient创建客户端。 ObsClient示例代码 透传密钥的客户端类 如果您需要在每次调用接口时，都为客户端设置一次访问凭证，OBS Java SDK提供了直接在接口方法中透传AK和SK的OBS客户端类SecretFlexibleObsClient，SecretFlexibleObsClient继承自ObsClient。 SecretFlexibleObsClient示例代码 访问凭证获取方式 从变量传入 创建OBS客户端实例，并使用变量传入方式的访问凭证。 访问凭证变量直接作为参数示例代码 BasicObsCredentialsProvider示例代码 从环境变量获取 创建OBS客户端实例，并使用EnvironmentVariableObsCredentialsProvider从环境变量获取访问凭证。 EnvironmentVariableObsCredentialsProvider示例代码 ECS场景从云服务委托获取 创建OBS客户端实例，并使用EcsObsCredentialsProvider从ECS服务器自动获取临时访问密钥，并且访问凭证会定期自动刷新。 须知： 使用EcsObsCredentialsProvider的前提，应用程序须运行在ECS服务器上，并且ECS绑定了 IAM 对ECS的云服务委托（该委托拥有OBS权限）。 请确保服务端和应用程序部署所在环境的UTC时间一致，否则可能会导致临时访问密钥无法及时刷新。 使用该方式创建客户端时，SDK会请求固定IP（169.254.169.254）的API获取临时AKSK，具体请参见在ECS上获取Security Key。 EnvironmentVariableObsCredentialsProvider示例代码 链式获取 以链式的方式从预定义方式列表中搜索访问密钥，以第一组成功获取到的访问密钥创建OBS客户端。 当前顺序是默认先从环境变量，再从ECS服务器委托中进行搜索，暂不支持自定义获取方式和顺序。 OBSCredentialsProviderChain示例代码 其他配置 只配置终端节点（endpoint） 除了访问凭证外，只配置中终端节点（endpoint）参数。 除访问凭证外只配置endpoint示例代码 除了配置终端节点（endpoint）还有其他配置 除了配置终端节点（endpoint）还需要配置HTTP代理、Socket层传输数据超时时间等参数，您可通过ObsConfiguration配置类对ObsClient进行配置，支持的配置项参见表2。 ObsConfiguration示例代码

注意事项 客户端在创建时必须同步完成客户端配置，配置机会仅有一次，创建完成后，不能对客户端进行二次配置。 在使用临时aksk时，aksk会有过期时间，可调用ObsClient.refresh("yourAccessKey", "yourSecretKey", "yourSecurityToken")刷新ObsClient的aksk，不必重新创建ObsClient。 建议整个代码工程全局使用一个ObsClient客户端，只在程序初始化时创建一次，因为创建多个ObsClient客户端在高并发场景下会影响性能。 ObsClient是线程安全的，可在并发场景下使用。 ObsClient在调用ObsClient.close方法关闭后不能再次使用，保证全局使用一个ObsClient客户端的情况下，不建议主动关闭ObsClient客户端。

构造函数参数描述 参数 描述 建议值 access_key_id 访问密钥中的AK。默认为空字符串表示匿名用户。 N/A secret_access_key 访问密钥中的SK。默认为空字符串表示匿名用户。 N/A security_token 临时访问密钥中的SecurityToken。 如何获取临时访问密钥和securitytoken请参见临时访问密钥AK/SK获取； N/A server 连接OBS的服务地址。可包含协议类型、域名、端口号。示例：https://your-endpoint:443。（出于安全性考虑，建议使用https协议） N/A max_retry_count HTTP/HTTPS连接异常时的请求重试次数。默认为3次。 [1，5] max_redirect_count HTTP/HTTPS请求重定向的最大次数。默认为10次 [1, 10] timeout HTTP/HTTPS请求超时时间（单位：秒）。默认为60秒。 [10， 60] ssl_verify 验证服务端证书参数，即验证服务端证书与客户端证书配置的证书是否一致。可能的取值： 服务端pem格式根证书文件路径。 True：从操作系统根证书库中获取服务端证书列表并验证服务端证书（仅支持Windows操作系统）。 False：表示不验证服务端证书。 默认为False。 N/A chunk_size 读写socket流时的块大小（单位：字节），您可以根据自身需求设置块大小。默认为65536字节。 默认 long_conn_mode 是否启用长连接模式。默认为False。 N/A proxy_host 代理服务器的主机地址。默认为空。 说明： 请注意，代理服务器的主机地址不要指定http://或https://； N/A proxy_port 代理服务器的端口号。默认为空。 N/A proxy_username 连接代理服务器时使用的用户名。默认为空。 N/A proxy_password 连接代理服务器时使用的用户密码。默认为空。 N/A is_cname 是否通过自定义域名访问OBS服务。默认为False。 更多关于自定义域名相关信息请参见自定义域名。 N/A security_providers 指定允许的访问密钥搜索方式，OBS客户端将使用该参数指定的搜索方式，搜索并获取访问密钥。默认为None。 说明： security_providers参数必须采用列表形式，默认情况下security_providers为None，此时默认提供从环境变量中获取访问密钥，或从ECS服务器获取临时访问密钥两种方式作为security_providers的默认搜索方式。 当指定了security_providers参数时，则不会提供默认搜索方式，此时仅可以使用security_providers中提供的搜索方式。 N/A security_provider_policy 指定访问密钥搜索策略。默认为None。 说明： security_provider_policy参数用于设置搜索策略，默认为None，此时需要显示指定访问密钥；同时，在已经指定了访问密钥参数的情况下，security_provider_policy参数将被忽略。 security_provider_policy设置为OBS_DEFAULT时采用链式搜索方式获取访问密钥； 设置security_provider_policy为预定义方式名（ENV，ECS）时采用对应方式获取访问密钥。 N/A 建议值为N/A的表示需要根据实际情况进行设置。 如网络状况不佳，建议增大timeout的值。 如果设置的server不带协议类型，则默认使用HTTPS协议。 如果启用了长连接模式，使用完OBS客户端后必须调用ObsClient.close方法显式关闭，回收连接资源。 出于DNS解析性能和OBS服务可靠性的考虑，不允许将server设置为IP，必须使用域名访问OBS服务。

代码样例 通过构造函数创建OBS客户端，永久访问密钥（AK/SK）创建OBS客户端代码如下： # 引入模块 from obs import ObsClient # 推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险。 # 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html。 ak = os.getenv("AccessKeyID") sk = os.getenv("SecretAccessKey") # server填写Bucket对应的Endpoint, 这里以华北-北京四为例，其他地区请按实际情况填写。 server = "https://obs.cn-north-4.myhuaweicloud.com" # 创建obsClient实例 securityToken值 obsClient = ObsClient(access_key_id=ak, secret_access_key=sk, server=server) # 使用访问OBS # 关闭obsClient obsClient.close() 临时访问密钥（AK/SK和SecurityToken）创建OBS客户端代码如下： # 引入模块 from obs import ObsClient # 推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险。 # 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html。 ak = os.getenv("AccessKeyID") sk = os.getenv("SecretAccessKey") # 【可选】如果使用临时AKSK和SecurityToken访问OBS，则同样推荐通过环境变量获取 security_token = os.getenv("SecurityToken") # server填写Bucket对应的Endpoint, 这里以华北-北京四为例，其他地区请按实际情况填写。 server = "https://obs.cn-north-4.myhuaweicloud.com" # 创建obsClient实例 # 如果使用临时AKSK和SecurityToken访问OBS，需要在创建实例时通过security_token参数指定securityToken值 obsClient = ObsClient( access_key_id=ak, secret_access_key=sk, server=server, security_token=security_token ) # 使用访问OBS # 关闭obsClient obsClient.close() 指定获取临时访问密钥的方式 使用单一的获取方式，以从环境变量获取访问密钥的方式为例： # 引入模块 from obs import ObsClient from obs import loadtoken # 创建ObsClient实例 # 提供ENV方式获取访问密钥 obsClient = ObsClient( server='https://your-endpoint', security_providers=[loadtoken.ENV] ) # 使用访问OBS # 关闭obsClient obsClient.close() 通过配置系统环境变量的方式或者通过访问ECS服务器获取临时访问密钥的方式创建OBS客户端。 使用ENV方式创建OBS客户端的代码如下： # 引入模块 from obs import ObsClient # 创建ObsClient实例 # 提供ENV方式获取访问密钥 obsClient = ObsClient( server='https://your-endpoint', security_provider_policy='ENV' ) # 使用访问OBS # 关闭obsClient obsClient.close() 以上方式会从当前系统的环境变量中寻找访问密钥，需要对应在环境变量中定义OBS_ACCESS_KEY_ID、OBS_SECRET_ACCESS_KEY字段。同时如果采用临时访问密钥时，还需要在环境变量中定义OBS_SECURITY_TOKEN字段。 使用ECS方式创建OBS客户端的代码如下： # 引入模块 from obs import ObsClient # 创建ObsClient实例 # 提供ECS方式获取临时访问密钥 obsClient = ObsClient( server='https://your-endpoint', security_provider_policy='ECS' ) # 使用访问OBS # 关闭obsClient obsClient.close() 当应用程序部署在ECS服务器上时，可以采用以上方式从ECS服务器上自动获取临时访问密钥和定期自动刷新。 如果客户端报401错误，则需要排查在创建ECS时是否有添加委托。 在使用该方式获取临时访问密钥时，请确保服务端和应用程序部署所在环境的UTC时间一致，否则可能会导致临时访问密钥无法及时刷新的问题。 除了上述指定一种方式获取访问密钥外，还可以以链式的形式从环境变量及ECS服务器上进行搜索以获取对应的访问密钥。 通过设定security_provider_policy参数为OBS_DEFAULT来指定OBS客户端以链式的方式搜索访问密钥： # 引入模块 from obs import ObsClient # 创建ObsClient实例 # 以链式的方式从环境变量和ECS中搜索访问密钥 obsClient = ObsClient( server='https://your-endpoint', security_provider_policy='OBS_DEFAULT' ) # 使用访问OBS # 关闭obsClient obsClient.close() 以上方式通过设定security_provider_policy为OBS_DEFAULT，可以指定以链式的方式从预定义方式列表中搜索访问密钥。当前默认提供从环境变量中以及从ECS服务器上获取访问密钥两种预定义搜索方式，并按照先从环境变量，再从ECS服务器的顺序进行搜索。链式搜索方式会以第一组成功获取到的访问密钥创建OBS客户端。 工程中可以有多个ObsClient，也可以只有一个ObsClient。 ObsClient是线程安全的，可在并发场景下使用。

初始化概述(Java SDK) 完成SDK安装之后，您还需要进行初始化工作，初始化工作主要包括两方面，一方面客户端的创建和配置，另一方面是SDK日志配置。 表1 初始化概述 初始化任务 子任务 是否必选 说明 创建并配置客户端 创建客户端 是 OBS客户端是使用Java SDK访问OBS服务的必备媒介，它为调用者提供一系列与OBS服务进行交互的接口，使用OBS Java SDK向OBS发起请求，您需要创建并初始化一个客户端，即一个ObsClient实例。 配置访问密钥 是 基于安全需要，您需要为客户端配置访问凭证以便服务端校验请求的合法性。 配置终端节点及其他选项 终端节点必选，其余配置项可选 为了快速创建和检索到您的资源，需要配置客户端的终端节点，即告知服务端资源所在的区域。 除了访问密钥和终端节点外，您可以根据自身使用场景，为客户端配置其他选项。 配置SDK日志 配置日志等级 否 OBS Java SDK基于Apache Log4j2开源库提供了日志功能，Log4j2框架按照优先级将日志进行了分级处理，您可以配置存储某个级别以上的日志，自行决定存储日志的范围。 OBS Java SDK默认将WARN及WARN以上级别的日志保存到本地。 配置日志存放路径 否 配置日志在本地的存储路径。 父主题： 初始化(Java SDK)

自定义域名访问介绍与配置 当以自定义域名访问OBS桶时，需要先将该自定义域名同对应OBS桶访问域名进行绑定，相关配置请参见自定义域名绑定简介，自定义域名绑定配置。 当在自定义域名上配置了 CDN加速 服务，即自定义域名为CDN服务的加速域名时，需要额外对CDN服务进行配置，以保证可以正常使用自定义域名访问OBS服务。 以华为云CDN服务为例，相关配置如下所示： 登录华为云CDN服务，从CDN服务左侧列表中选择域名管理项，在该项中可以查看到所有配置的CDN服务域名信息。 配置源站。单击要使用的自定义域名项，进入域名配置界面，编辑源站配置，选择主源站类型为源站域名类型，对应源站为要访问的OBS桶域名。 配置回源HOST。回源HOST必须指定为加速域名即访问OBS服务时访问的自定义域名，否则可能会出现回源鉴权失败的问题。

配置密钥 开发过程中，您有任何问题可以在github上提交issue，或者在华为云 对象存储服务 论坛中发帖求助。接口参考文档详细介绍了每个接口的参数和使用方法。 要接入OBS服务，您需要拥有一组有效的访问密钥（AK和SK）用来进行签名认证。 具体可参考OBS服务环境搭建。 获取AK和SK之后，您便可以按照以下步骤进行初始化。 创建OBS客户端 配置OBS客户端 配置SDK日志 异步调用 父主题： 初始化

Token认证 参数authToken和graphEndpoint如何填写见初始化参数获取。 import com.huawei.ges.graph.v1.GESGraphClient; // 内存版客户端 import com.huawei.ges.graph.v1.persistence.GESGraphPersistenceClient; // 持久化版客户端 import com.huawei.ges.graph.v1.auth.token.GesGraphTokenCredentials; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.http.HttpConfig; import java.util.Arrays; String authToken = ""; String graphEndpoint = ""; ICredential auth = new GesGraphTokenCredentials().withXAuthToken(authToken); HttpConfig httpConfig = HttpConfig.getDefaultHttpConfig(); // 内存版客户端 GESGraphClient gesGraphClient = GESGraphClient.newBuilder().withCredential(auth).withEndpoints(Arrays.asList(graphEndpoint)).withHttpConfig(httpConfig).build(); // 持久化版客户端 GESGraphPersistenceClient gesGraphPersistenceClient = GESGraphPersistenceClient.newBuilder().withCredential(auth).withEndpoints(Arrays.asList(graphEndpoint)).withHttpConfig(httpConfig).build();

密码认证 参数domainName、userName、password、projectId 、iamEndPoint和graphEndpoint如何填写见初始化参数获取。 import com.huawei.ges.graph.v1.GESGraphClient; // 内存版客户端 import com.huawei.ges.graph.v1.persistence.GESGraphPersistenceClient; // 持久化版客户端 import com.huawei.ges.graph.v1.auth.password.GesGraphPasswordCredentials; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.http.HttpConfig; import java.util.Arrays; // 认证用的密码硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全 // 本示例以密码保存在环境变量中来实现身份验证为例，运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_PWD String password = System.getenv("HUAWEICLOUD_SDK_PWD"); String domainName = ""; String userName = ""; String projectId = ""; String iamEndPoint = ""; String graphEndpoint = ""; ICredential auth = new GesGraphPasswordCredentials(userName, domainName, password, projectId, Arrays.asList(iamEndPoint)); HttpConfig httpConfig = HttpConfig.getDefaultHttpConfig(); // 内存版客户端 GESGraphClient gesGraphClient = GESGraphClient.newBuilder().withCredential(auth).withEndpoints(Arrays.asList(graphEndpoint)).withHttpConfig(httpConfig).build(); // 持久化版客户端 GESGraphPersistenceClient gesGraphPersistenceClient = GESGraphPersistenceClient.newBuilder().withCredential(auth).withEndpoints(Arrays.asList(graphEndpoint)).withHttpConfig(httpConfig).build();

客户端连接参数 Java import com.huaweicloud.sdk.core.http.HttpConfig; // 使用默认配置 HttpConfig config = HttpConfig.getDefaultHttpConfig(); // 默认连接超时时间为60秒，可根据需要调整 config.withTimeout(60) // 根据需要配置是否跳过SSL证书验证 config.withIgnoreSSLVerification(true); // 或者自定义SSLSocketFactory和TrustManager，需要用户自行实现 config.withSSLSocketFactory(sslSocketFactory).withX509TrustManager(trustManager); Python # HttpConfig提供连接参数，可根据需要调整：proxy_protocol, proxy_host, proxy_port, proxy_user, proxy_password, ignore_ssl_verification, ssl_ca_cert, cert_file, key_file, timeout, retry_times, pool_connections, pool_maxsize, allow_redirects from huaweicloudsdkcore.http.http_config import HttpConfig http_conf = HttpConfig(ignore_ssl_verification=True, timeout=60) 父主题： 初始化GES业务面客户端

参数描述 表1 LogConfig 参数名称 参数类型 是否必选 描述 level LogLevel 必选 参数解释： 日志级别。 表2 LogLevel 常量名 原始值 说明 OFF off 关闭级别，如果设置为这个级别，日志打印功能将被关闭。 ERROR error 错误级别，如果设置为这个级别，仅打印发生异常时的错误信息。 WARN warn 告警级别，如果设置为这个级别，除了打印错误级别的信息外，还将打印一些关键事件的信息。 INFO info 信息级别，如果设置为这个级别，除了打印告警级别的信息外，还将打印HTTP/HTTPS请求的耗时时间，ObsClient接口的耗时时间等。 DEBUG debug 调试级别，如果设置为这个级别，除了打印INFO级别的信息外，还将打印每次HTTP/HTTPS请求和响应的头信息、鉴权算法计算出的stringToSign信息等。

配置密钥(Node.js SDK) 开发过程中，您有任何问题可以在github上提交issue，或者在华为云对象存储服务论坛中发帖求助。 要接入OBS服务，您需要拥有一组有效的访问密钥（AK和SK）用来进行签名认证。具体可参考OBS服务环境搭建。 获取AK和SK之后，可以通过创建OBS客户端，调用SDK接口。 获取AK和SK之后，您便可以按照以下步骤进行初始化。 创建OBS客户端(Node.js SDK) 配置OBS客户端(Node.js SDK) 配置SDK日志(Node.js SDK) 配置SDK代理(Node.js SDK) 父主题： 初始化(Node.js SDK)