初始化
确认Endpoint
在确认您使用SDK时配置的Endpoint时,可先参考阅读API参考中关于 API服务域名 的部分,理解Endpoint相关的概念。 百度智能云目前开放了多区域支持,请参考区域选择说明。 对应信息为:
| 访问区域 | 对应Endpoint |
|---|---|
| 北京 | bci.bj.baidubce.com |
| 广州 | bci.gz.baidubce.com |
| 苏州 | bci.su.baidubce.com |
| 保定 | bci.bd.baidubce.com |
| 武汉 | bci.fwh.baidubce.com |
获取密钥
要使用百度智能云BCI,您需要拥有一个有效的 AK(Access Key ID)和SK(Secret Access Key)用来进行签名认证。AK/SK是由系统分配给用户的,均为字符串,用于标识用户,为访问BCI做签名验证。 可以通过如下步骤获得并了解您的AK/SK信息:
新建BciClient
BciClient是BCI服务的客户端,为开发者与BCI服务进行交互提供了一系列的方法。
使用AK/SK新建BciClient
通过AK/SK方式访问BCI,用户可以参考如下代码新建一个BciClient:
1public class Sample {
2public static void main(String[] args) {
3 String ACCESS_KEY_ID = <your-access-key-id>; // 用户的 Access Key ID
4 String SECRET_ACCESS_KEY = <your-secret-access-key>; // 用户的Secret Access Key
5 String ENDPOINT = <domain-name>; // 用户自己指定的域名
6
7 BciClientConfiguration config = new BciClientConfiguration();
8 config.setCredentials(new DefaultBceCredentials(ACCESS_KEY_ID,SECRET_ACCESS_KEY));
9 config.setEndpoint(ENDPOINT);
10 BciClient client = new BciClient(config);
11}
使用STS创建BciClient
申请STS token
BCI可以通过STS机制实现第三方的临时授权访问。STS(Security Token Service)是百度智能云提供的临时授权服务。通过STS,您可以为第三方用户颁发一个自定义时效和权限的访问凭证。第三方用户可以使用该访问凭证直接调用百度智能云的API或SDK访问百度智能云资源。
通过STS方式访问BCI,用户需要先通过STS的client申请一个认证字符串,申请方式可参见百度智能云STS使用介绍。
用STS token新建BciClient
申请好STS后,可将STStoken配置到BciClient中,用户可以参考如下代码新建一个BciClient:
1public class StsExample {
2 private static final String STS_ENDPOINT = "http://sts.bj.baidubce.com";
3 private static final String ENDPOINT = "bci.bj.baidubce.com";
4 private static final String ACCESS_KEY_ID = "your accesskey id";
5 private static final String SECRET_ACCESS_KEY = "your secret accesskey";
6
7 public static void main(String[] args) {
8 BceCredentials credentials = new DefaultBceCredentials(ACCESS_KEY_ID, SECRET_ACCESS_KEY);
9 StsClient client = new StsClient(
10 new BceClientConfiguration().withEndpoint(STS_ENDPOINT).withCredentials(credentials)
11 );
12 GetSessionTokenResponse response = client.getSessionToken(new GetSessionTokenRequest());
13 // or simply call:
14 // GetSessionTokenResponse response = client.getSessionToken();
15 // or you can specify limited permissions with ACL:
16 // GetSessionTokenResponse response = client.getSessionToken(new GetSessionTokenRequest().withAcl("blabla"));
17 // build DefaultBceSessionCredentials object from response:
18 BceCredentials bcistsCredentials = new DefaultBceSessionCredentials(
19 response.getAccessKeyId(),
20 response.getSecretAccessKey(),
21 response.getSessionToken());
22 System.out.println("==================================");
23 System.out.println("GetSessionToken result:");
24 System.out.println(" accessKeyId: " + response.getAccessKeyId());
25 System.out.println(" secretAccessKey: " + response.getSecretAccessKey());
26 System.out.println(" securityToken: " + response.getSessionToken());
27 System.out.println(" expiresAt: " + response.getExpiration().toString());
28 System.out.println("==================================");
29
30 // build bci client
31 BciClientConfiguration config = new BciClientConfiguration();
32 config.setCredentials(bcistsCredentials);
33 config.setEndpoint(ENDPOINT);
34 BciClient bciClient = new BciClient(config);
35 }
36}
注意: 目前使用STS配置client时,无论对应bucket的区域在哪里,endpoint都需配置为
http://sts.bj.baidubce.com, 但创建BciClient时,仍需使用BCI的endpoint,如bci.bj.baidubce.com、bci.su.baidubce.com等.
配置自定义域名访问 BCI
使用自定义域名
如果希望使用自定义域名作为访问 BCI 的 endpoint,在控制台将自定义域名和 BCI 某个 bucket 绑定之后,配置 endpoint 为自定义域名并打开 CnameEnabled 开关,例如 cdn-test.cdn.bcebci.com,配置代码如下:
1import com.baidubce.auth.DefaultBceCredentials;
2import com.baidubce.services.bci.BciClient;
3import com.baidubce.services.bci.BciClientConfiguration;
4
5public class CustomDomainExample {
6 public static void main(String[] args) {
7 String accessKeyId = "your-access-key-id";
8 String secretAccessKey = "your-secret-access-key";
9 String endpoint = "https://cdn-test.cdn.bcebci.com";
10
11 BciClientConfiguration config = new BciClientConfiguration();
12 config.setCredentials(new DefaultBceCredentials(accessKeyId, secretAccessKey));
13 config.setEndpoint(endpoint);
14 config.setCnameEnabled(true);
15
16 BciClient client = new BciClient(config);
17 }
18}
其中,endpoint 为已绑定的自定义域名,config.setCnameEnabled(true) 表示按 CNAME 方式访问 BCI。示例中的 cdn-test.cdn.bcebci.com 为示例域名。
配置 HTTPS 协议访问 BCI
BCI 支持 HTTPS 传输协议,您可以通过如下两种方式在 BCI Java SDK 中使用 HTTPS 访问 BCI 服务:
- 在 endpoint 中指明
https:。
1import com.baidubce.auth.DefaultBceCredentials;
2import com.baidubce.services.bci.BciClient;
3import com.baidubce.services.bci.BciClientConfiguration;
4
5public class HttpsEndpointExample {
6 public static void main(String[] args) {
7 String endpoint = "https://bci.bj.baidubce.com";
8 String accessKeyId = "your-access-key-id";
9 String secretAccessKey = "your-secret-access-key";
10
11 BciClientConfiguration config = new BciClientConfiguration();
12 config.setEndpoint(endpoint);
13 config.setCredentials(new DefaultBceCredentials(accessKeyId, secretAccessKey));
14
15 BciClient client = new BciClient(config);
16 }
17}
其中,endpoint 为包含 https:// 的完整服务地址。
- 通过调用
setProtocol方法设置https协议:
1import com.baidubce.Protocol;
2import com.baidubce.auth.DefaultBceCredentials;
3import com.baidubce.services.bci.BciClient;
4import com.baidubce.services.bci.BciClientConfiguration;
5
6public class HttpsProtocolExample {
7 public static void main(String[] args) {
8 String endpoint = "bci.bj.baidubce.com";
9 String accessKeyId = "your-access-key-id";
10 String secretAccessKey = "your-secret-access-key";
11
12 BciClientConfiguration config = new BciClientConfiguration();
13 config.setCredentials(new DefaultBceCredentials(accessKeyId, secretAccessKey));
14 config.setEndpoint(endpoint);
15 config.setProtocol(Protocol.HTTPS);
16
17 BciClient client = new BciClient(config);
18 }
19}
其中,endpoint 为不包含 scheme 的服务域名,config.setProtocol(Protocol.HTTPS) 用于单独指定协议类型。
注意: 如果在
endpoint中指明了 protocol,则以endpoint中的配置为准,另外单独再调用setProtocol()不起作用。
1import com.baidubce.Protocol;
2import com.baidubce.auth.DefaultBceCredentials;
3import com.baidubce.services.bci.BciClient;
4import com.baidubce.services.bci.BciClientConfiguration;
5
6public class ProtocolOverrideExample {
7 public static void main(String[] args) {
8 String endpoint = "http://bci.bj.baidubce.com";
9 String accessKeyId = "your-access-key-id";
10 String secretAccessKey = "your-secret-access-key";
11
12 BciClientConfiguration config = new BciClientConfiguration();
13 config.setCredentials(new DefaultBceCredentials(accessKeyId, secretAccessKey));
14 config.setEndpoint(endpoint);
15 config.setProtocol(Protocol.HTTPS);
16
17 BciClient client = new BciClient(config);
18 }
19}
上述示例用于说明:当 endpoint 已包含 scheme 时,setProtocol() 不会覆盖 endpoint 中的协议配置。
配置BciClient
如果用户需要配置BciClient的一些细节的参数,可以在构造BciClient的时候传入BciClientConfiguration对象。 BciClientConfiguration是BCI服务的配置类,可以为客户端配置代理,最大连接数等参数。
使用代理
下面一段代码可以让客户端使用代理访问 BCI 服务:
1import com.baidubce.auth.DefaultBceCredentials;
2import com.baidubce.services.bci.BciClient;
3import com.baidubce.services.bci.BciClientConfiguration;
4
5public class ProxyExample {
6 public static void main(String[] args) {
7 String accessKeyId = "your-access-key-id";
8 String secretAccessKey = "your-secret-access-key";
9 String endpoint = "bci.bj.baidubce.com";
10
11 BciClientConfiguration config = new BciClientConfiguration();
12
13 // 配置代理为本地 8080 端口
14 config.setProxyHost("127.0.0.1");
15 config.setProxyPort(8080);
16
17 config.setCredentials(new DefaultBceCredentials(accessKeyId, secretAccessKey));
18 config.setEndpoint(endpoint);
19
20 BciClient client = new BciClient(config);
21 }
22}
使用上面的代码段,客户端的所有操作都会通过 127.0.0.1 地址的 8080 端口做代理执行。
对于有用户验证的代理,可以通过下面的代码段配置用户名和密码:
1import com.baidubce.services.bci.BciClientConfiguration;
2
3public class AuthenticatedProxyExample {
4 public static void main(String[] args) {
5 BciClientConfiguration config = new BciClientConfiguration();
6
7 // 配置代理为本地 8080 端口
8 config.setProxyHost("127.0.0.1");
9 config.setProxyPort(8080);
10
11 // 设置用户名和密码
12 config.setProxyUsername("your-proxy-username");
13 config.setProxyPassword("your-proxy-password");
14 }
15}
其中,ProxyHost 和 ProxyPort 用于指定代理地址;ProxyUsername 和 ProxyPassword 用于设置需要认证的代理凭据。
设置网络参数
用户可以用BciClientConfiguration对基本网络参数进行设置:
1BciClientConfiguration config = new BciClientConfiguration();
2
3// 设置HTTP最大连接数为10
4config.setMaxConnections(10);
5
6// 设置TCP连接超时为5000毫秒
7config.setConnectionTimeoutInMillis(5000);
8
9// 设置Socket传输数据超时的时间为2000毫秒
10config.setSocketTimeoutInMillis(2000);
设置同步PUT
对PUT操作,默认使用CloseableHttpAsyncClient,可能会出现用户进程执行完未退出的现象。用户可以通过BciClientConfiguration设置所有BCI请求都通过BciClient同步的方式:
1BciClientConfiguration config = new BciClientConfiguration();
2
3// 设置PUT操作为同步方式,默认异步
4config.setEnableHttpAsyncPut(false);
参数说明
通过BciClientConfiguration能指定的所有参数如下表所示:
| 参数 | 说明 |
|---|---|
| CnameEnabled | 使用cname访问BCI资源 |
| ConnectionTimeoutInMillis | 建立连接的超时时间(单位:毫秒) |
| Credentials | 客户端用于签署HTTP请求的BCE凭据 |
| EnableHttpAsyncPut | 异步put |
| Endpoint | 访问域名 |
| LocalAddress | 本地地址 |
| MaxConnections | 允许打开的最大HTTP连接数 |
| Protocol | 连接协议类型 |
| ProxyDomain | 访问NTLM验证的代理服务器的Windows域名 |
| ProxyHost | 代理服务器主机地址 |
| ProxyPassword | 代理服务器验证的密码 |
| ProxyPort | 代理服务器端口 |
| ProxyPreemptiveAuthenticationEnabled | 是否设置用户代理认证 |
| ProxyUsername | 代理服务器验证的用户名 |
| ProxyWorkstation | NTLM代理服务器的Windows工作站名称 |
| Region | 地域 |
| RetryPolicy | 连接重试策略 |
| SocketBufferSizeInBytes | Socket缓冲区大小 |
| SocketTimeoutInMillis | 通过打开的连接传输数据的超时时间(单位:毫秒) |
| StreamBufferSize | 流文件缓冲区大小 |
| UserAgent | 用户代理,指HTTP的User-Agent头 |
| RedirectsEnabled | 是否开启HTTP重定向。默认开启 |
评价此篇文章
