初始化
确认Endpoint
在确认您使用SDK时配置的Endpoint时,可先参考阅读API参考中关于 API服务域名 的部分,理解Endpoint相关的概念。 百度智能云目前开放了多区域支持,请参考区域选择说明。 对应信息为:
访问区域 | 对应Endpoint |
---|---|
北京 | eip.bj.baidubce.com |
广州 | eip.gz.baidubce.com |
苏州 | eip.su.baidubce.com |
香港 | eip.hkg.baidubce.com |
武汉 | eip.fwh.baidubce.com |
保定 | eip.bd.baidubce.com |
获取密钥
要使用百度智能云EIP,您需要拥有一个有效的 AK(Access Key ID)和SK(Secret Access Key)用来进行签名认证。AK/SK是由系统分配给用户的,均为字符串,用于标识用户,为访问EIP做签名验证。 可以通过如下步骤获得并了解您的AK/SK信息: 注册百度智能云账号 创建AK/SK
新建EipClient/EipGroupClient/EipBpClient
EipClient是Eip服务的客户端,为开发者与Eip服务进行交互提供了一系列的方法。
使用AK/SK新建EipClient/EipGroupClient/EipBpClient
通过AK/SK方式访问Eip,用户可以参考如下代码新建一个Client:
1public class Sample {
2 public 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
6 // 初始化一个EipClient
7 BceClientConfiguration config = new BceClientConfiguration();
8 config.setCredentials(new DefaultBceCredentials(ACCESS_KEY_ID, SECRET_ACCESS_KEY));
9 EipClient client = new EipClient(config);
10
11 // 初始化一个EipGroupClient
12 BceClientConfiguration config = new BceClientConfiguration();
13 config.setCredentials(new DefaultBceCredentials(ACCESS_KEY_ID, SECRET_ACCESS_KEY));
14 EipGroupClient client = new EipGroupClient(config);
15
16 // 初始化一个EipBpClient
17 BceClientConfiguration config = new BceClientConfiguration();
18 config.setCredentials(new DefaultBceCredentials(ACCESS_KEY_ID, SECRET_ACCESS_KEY));
19 EipBpClient client = new EipGroupClient(config);
20 }
21}
在上面代码中,ACCESS_KEY_ID
对应控制台中的“Access Key ID”,SECRET_ACCESS_KEY
对应控制台中的“Access Key Secret”,获取方式请参考《操作指南 管理ACCESSKEY》。
上面的方式使用默认域名作为Eip的服务地址,如果用户需要自己指定域名,可以通过传入ENDPOINT参数来指定。
1 String ACCESS_KEY_ID = <your-access-key-id>; // 用户的Access Key ID
2 String SECRET_ACCESS_KEY = <your-secret-access-key>; // 用户的Secret Access Key
3 String ENDPOINT = <domain-name>; // 用户自己指定的域名
4
5 BceClientConfiguration config = new BceClientConfiguration();
6 config.setCredentials(new DefaultBceCredentials(ACCESS_KEY_ID,SECRET_ACCESS_KEY));
7 config.setEndpoint(ENDPOINT);
8 EipClient client = new EipClient(config);
9 EipGroupClient client = new EipGroupClient(config);
10 EipBpClient client = new EipBpClient(config);
注意:
ENDPOINT
参数只能用指定的包含区域的域名来进行定义,不指定时默认为北京区域http://eip.bj.baidubce.com
。
使用STS创建EipClient/EipGroupClient/EipBpClient
申请STS token
EIP可以通过STS机制实现第三方的临时授权访问。STS(Security Token Service)是百度智能云提供的临时授权服务。通过STS,您可以为第三方用户颁发一个自定义时效和权限的访问凭证。第三方用户可以使用该访问凭证直接调用百度智能云的API或SDK访问百度智能云资源。
通过STS方式访问EIP,用户需要先通过STS的client申请一个认证字符串,申请方式可参见百度智能云STS使用介绍。
用STS token新建EipClient
申请好STS后,可将STStoken配置到EipClient中,用户可以参考如下代码新建一个EipClient:
1public class StsExample {
2 private static final String STS_ENDPOINT = "http://sts.bj.baidubce.com";
3 private static final String ACCESS_KEY_ID = "your accesskey id";
4 private static final String SECRET_ACCESS_KEY = "your secret accesskey";
5
6 public static void main(String[] args) {
7 BceCredentials credentials = new DefaultBceCredentials(ACCESS_KEY_ID, SECRET_ACCESS_KEY);
8 StsClient client = new StsClient(
9 new BceClientConfiguration().withEndpoint(STS_ENDPOINT).withCredentials(credentials)
10 );
11 GetSessionTokenResponse response = client.getSessionToken(new GetSessionTokenRequest());
12 // or simply call:
13 // GetSessionTokenResponse response = client.getSessionToken();
14 // or you can specify limited permissions with ACL:
15 // GetSessionTokenResponse response = client.getSessionToken(new GetSessionTokenRequest().withAcl("blabla"));
16 // build DefaultBceSessionCredentials object from response:
17 BceCredentials eipStsCredentials = new DefaultBceSessionCredentials(
18 response.getAccessKeyId(),
19 response.getSecretAccessKey(),
20 response.getSessionToken());
21 System.out.println("==================================");
22 System.out.println("GetSessionToken result:");
23 System.out.println(" accessKeyId: " + response.getAccessKeyId());
24 System.out.println(" secretAccessKey: " + response.getSecretAccessKey());
25 System.out.println(" securityToken: " + response.getSessionToken());
26 System.out.println(" expiresAt: " + response.getExpiration().toString());
27 System.out.println("==================================");
28
29 // build eip client
30 BceClientConfiguration config = new BceClientConfiguration();
31 config.setCredentials(eipStsCredentials);
32 EipClient eipClient = new EipClient(config);
33 EipGroupClient client = new EipGroupClient(config);
34 EipBpClient client = new EipBpClient(config);
35 }
36}
注意: 目前使用STS配置client时,无论对应EIP服务的endpoint在哪里,endpoint都需配置为
http://sts.bj.baidubce.com
。
配置HTTPS协议访问Eip/EipGroup/EipBp
EIP支持HTTPS传输协议,您可以通过如下两种方式在EIP Java SDK中使用HTTPS访问EIP服务:
- 在endpoint中指明https:
1 String endpoint = "https://eip.bj.baidubce.com";
2 String ak = "ak";
3 String sk = "sk";
4 BceClientConfiguration config = new BceClientConfiguration();
5 config.setCredentials(new DefaultBceCredentials(ak, sk));
6 EipClient client = new EipClient(config);
7 EipGroupClient client = new EipGroupClient(config);
8 EipBpClient client = new EipBpClient(config);
- 通过调用setProtocol方法设置https协议:
1 String endpoint = "eip.bj.baidubce.com"; // endpoint中不包含protocol
2 String ak = "ak";
3 String sk = "sk";
4 BceClientConfiguration config = new BceClientConfiguration();
5 config.setCredentials(new DefaultBceCredentials(ak, sk));
6 config.setEndpoint(ENDPOINT);
7 config.setProtocol(Protocol.HTTPS); // 如果不指明, 则使用http
8 EipClient client = new EipClient(config);
9 EipGroupClient client = new EipGroupClient(config);
10 EipBpClient client = new EipBpClient(config);
注意:如果在endpoint中指明了protocol, 则endpoint中的生效, 另外单独再调用setProtocol()不起作用。
1 String endpoint = "http://eip.bj.baidubce.com";
2 String ak = "ak";
3 String sk = "sk";
4 BceClientConfiguration config = new BceClientConfiguration();
5 config.setCredentials(new DefaultBceCredentials(ak, sk));
6 config.setEndpoint(ENDPOINT);
7 config.setProtocol(Protocol.HTTPS); // endpoint中已经指明, 此为无效操作, 对http也是如此
8 EipClient client = new EipClient(config);
9 EipGroupClient client = new EipGroupClient(config);
10 EipBpClient client = new EipBpClient(config);
配置EipClient/EipGroupClient/EipBpClient
如果用户需要配置EipClient的一些细节的参数,可以在构造EipClient的时候传入BceClientConfiguration对象,可以为客户端配置代理,最大连接数等参数。
使用代理
下面一段代码可以让客户端使用代理访问EIP服务:
1 String ACCESS_KEY_ID = <your-access-key-id>; // 用户的Access Key ID
2 String SECRET_ACCESS_KEY = <your-secret-access-key>; // 用户的Secret Access Key
3 String ENDPOINT = <domain-name>; // 用户自己指定的域名
4
5 // 创建BceClientConfiguration实例
6 BceClientConfiguration config = new BceClientConfiguration();
7
8 // 配置代理为本地8080端口
9 config.setProxyHost("127.0.0.1");
10 config.setProxyPort(8080);
11
12 // 创建EIP客户端
13 config.setCredentials(new DefaultBceCredentials(ACCESS_KEY_ID,SECRET_ACCESS_KEY));
14 config.setEndpoint(ENDPOINT);
15 EipClient client = new EipClient(config);
16 EipGroupClient client = new EipGroupClient(config);
17 EipBpClient client = new EipBpClient(config);
使用上面的代码段,客户端的所有操作都会通过127.0.0.1地址的8080端口做代理执行。
对于有用户验证的代理,可以通过下面的代码段配置用户名和密码:
1// 创建BceClientConfiguration实例
2 BceClientConfiguration config = new BceClientConfiguration();
3
4 // 配置代理为本地8080端口
5 config.setProxyHost("127.0.0.1");
6 config.setProxyPort(8080);
7
8 //设置用户名和密码
9 config.setProxyUsername(<username>); //用户名
10 config.setProxyPassword(<password>); //密码
设置网络参数
用户可以用BceClientConfiguration对基本网络参数进行设置:
1BceClientConfiguration config = new BceClientConfiguration();
2
3// 设置HTTP最大连接数为10
4config.setMaxConnections(10);
5
6// 设置TCP连接超时为5000毫秒
7config.setConnectionTimeout(5000);
8
9// 设置Socket传输数据超时的时间为2000毫秒
10config.setSocketTimeout(2000);
参数说明 通过BceClientConfiguration能指定的所有参数如下表所示:
参数 | 说明 |
---|---|
UserAgent | 用户代理,指HTTP的User-Agent头 |
Protocol | 连接协议类型 |
ProxyDomain | 访问NTLM验证的代理服务器的Windows域名 |
ProxyHost | 代理服务器主机地址 |
ProxyPort | 代理服务器端口 |
ProxyUsername | 代理服务器验证的用户名 |
ProxyPassword | 代理服务器验证的密码 |
ProxyPreemptiveAuthenticationEnabled | 是否设置用户代理认证 |
ProxyWorkstation | NTLM代理服务器的Windows工作站名称 |
LocalAddress | 本地地址 |
ConnectionTimeoutInMillis | 建立连接的超时时间(单位:毫秒) |
SocketTimeoutInMillis | 通过打开的连接传输数据的超时时间(单位:毫秒) |
MaxConnections | 允许打开的最大HTTP连接数 |
RetryPolicy | 连接重试策略 |
SocketBufferSizeInBytes | Socket缓冲区大小 |