初始化

更新时间：2023-12-20

确认Endpoint

在确认您使用SDK时配置的Endpoint时，可先参考阅读API参考中关于API服务域名的部分，理解Endpoint相关的概念。

访问区域	对应Endpoint
全局	bcc.bj.baidubce.com

获取AK/SK

要使用百度智能云ET，您需要拥有一个有效的 AK（Access Key ID）和SK(Secret Access Key)用来进行签名认证。AK/SK是由系统分配给用户的，均为字符串，用于标识用户，为访问服务做签名验证。可以通过如下步骤获得并了解您的AK/SK信息：

新建EtClient

EtClient是ET服务的客户端，为开发者与Et服务进行交互提供了一系列的方法。

使用AK/SK新建EtClient

通过AK/SK方式访问ET，用户可以参考如下代码新建一个Client：

public class Sample {
    public static void main(String[] args) {
        String ACCESS_KEY_ID = <your-access-key-id>;                   // 用户的Access Key ID
        String SECRET_ACCESS_KEY = <your-secret-access-key>;           // 用户的Secret Access Key
        
        // 初始化一个EtClient
        EtClientConfiguration config = new EtClientConfiguration();
        config.setCredentials(new DefaultBceCredentials(ACCESS_KEY_ID, SECRET_ACCESS_KEY));
        EtClient client = new EtClient(config);
    }
}

在上面代码中，ACCESS_KEY_ID对应控制台中的“Access Key ID”，SECRET_ACCESS_KEY对应控制台中的“Access Key Secret”，获取方式请参考《操作指南管理ACCESSKEY》。

上面的方式使用默认域名作为ET的服务地址，如果用户需要自己指定域名，可以通过传入ENDPOINT参数来指定。

 String ACCESS_KEY_ID = <your-access-key-id>;                   // 用户的Access Key ID
 String SECRET_ACCESS_KEY = <your-secret-access-key>;           // 用户的Secret Access Key
 String ENDPOINT = <domain-name>;                               // 用户自己指定的域名

 EtClientConfiguration config = new EtClientConfiguration();
 config.setCredentials(new DefaultBceCredentials(ACCESS_KEY_ID,SECRET_ACCESS_KEY));
 config.setEndpoint(ENDPOINT);
 EtClient client = new EtClient(config);

使用STS创建EtClient

申请STS token

ET可以通过STS机制实现第三方的临时授权访问。STS（Security Token Service）是百度智能云提供的临时授权服务。通过STS，您可以为第三方用户颁发一个自定义时效和权限的访问凭证。第三方用户可以使用该访问凭证直接调用百度智能云的API或SDK访问百度智能云资源。

通过STS方式访问ET，用户需要先通过STS的client申请一个认证字符串，申请方式可参见百度智能云STS使用介绍。

用STS token新建EtClient

申请好STS后，可将STStoken配置到EtClient中，用户可以参考如下代码新建一个EtClient：

public class StsExample {
    private static final String STS_ENDPOINT = "http://sts.bj.baidubce.com";
    private static final String ACCESS_KEY_ID = "your accesskey id";
    private static final String SECRET_ACCESS_KEY = "your secret accesskey";

    public static void main(String[] args) {
        BceCredentials credentials = new DefaultBceCredentials(ACCESS_KEY_ID, SECRET_ACCESS_KEY);
        StsClient client = new StsClient(
                new BceClientConfiguration().withEndpoint(STS_ENDPOINT).withCredentials(credentials)
        );
        GetSessionTokenResponse response = client.getSessionToken(new GetSessionTokenRequest());
        // or simply call:
        // GetSessionTokenResponse response = client.getSessionToken();
        // or you can specify limited permissions with ACL:
        // GetSessionTokenResponse response = client.getSessionToken(new GetSessionTokenRequest().withAcl("blabla"));
        // build DefaultBceSessionCredentials object from response:
        BceCredentials etStsCredentials = new DefaultBceSessionCredentials(
                response.getAccessKeyId(),
                response.getSecretAccessKey(),
                response.getSessionToken());
        System.out.println("==================================");
        System.out.println("GetSessionToken result:");
        System.out.println("    accessKeyId:  " + response.getAccessKeyId());
        System.out.println("    secretAccessKey:  " + response.getSecretAccessKey());
        System.out.println("    securityToken:  " + response.getSessionToken());
        System.out.println("    expiresAt:  " + response.getExpiration().toString());
        System.out.println("==================================");

        // build ET client
        EtClientConfiguration config = new EtClientConfiguration();
        config.setCredentials(etStsCredentials);
        EtClient client = new EtClient(config);
    }
}

注意：目前使用STS配置client时，无论对应ET服务的endpoint在哪里，endpoint都需配置为http://sts.bj.baidubce.com。

配置HTTPS协议访问ET

ET支持HTTPS传输协议，您可以通过如下两种方式在ET Java SDK中使用HTTPS访问ET服务：

在endpoint中指明https:

 String endpoint = "https://bcc.bj.baidubce.com";
 String ak = "ak";
 String sk = "sk";
 EtClientConfiguration config = new EtClientConfiguration();
 config.setCredentials(new DefaultBceCredentials(ak, sk));
 EtClient client = new EtClient(config);

通过调用setProtocol方法设置https协议:

 String endpoint = "bcc.bj.baidubce.com"; // endpoint中不包含protocol
 String ak = "ak";
 String sk = "sk";
 EtClientConfiguration config = new EtClientConfiguration();
 config.setCredentials(new DefaultBceCredentials(ak, sk));
 config.setEndpoint(ENDPOINT);
 config.setProtocol(Protocol.HTTPS); // 如果不指明, 则使用http
 EtClient client = new EtClient(config);

注意：如果在endpoint中指明了protocol, 则endpoint中的生效, 另外单独再调用setProtocol()不起作用。

 String endpoint = "http://bcc.bj.baidubce.com";
 String ak = "ak";
 String sk = "sk";
 EtClientConfiguration config = new EtClientConfiguration();
 config.setCredentials(new DefaultBceCredentials(ak, sk));
 config.setEndpoint(ENDPOINT);    
 config.setProtocol(Protocol.HTTPS); // endpoint中已经指明, 此为无效操作, 对http也是如此
 EtClient client = new EtClient(config);

配置EtClient

如果用户需要配置EtClient的一些细节的参数，可以在构造EtClient的时候传入EtClientConfiguration对象，可以为客户端配置代理，最大连接数等参数。

使用代理

下面一段代码可以让客户端使用代理访问ET服务：

 String ACCESS_KEY_ID = <your-access-key-id>;                   // 用户的Access Key ID
 String SECRET_ACCESS_KEY = <your-secret-access-key>;           // 用户的Secret Access Key
 String ENDPOINT = <domain-name>;                               // 用户自己指定的域名

 // 创建EtClientConfiguration实例
 EtClientConfiguration config = new EtClientConfiguration();

 // 配置代理为本地8080端口
 config.setProxyHost("127.0.0.1");
 config.setProxyPort(8080);

 // 创建ET客户端
 config.setCredentials(new DefaultBceCredentials(ACCESS_KEY_ID,SECRET_ACCESS_KEY));
 config.setEndpoint(ENDPOINT);
 EtClient client = new EtClient(config);

使用上面的代码段，客户端的所有操作都会通过127.0.0.1地址的8080端口做代理执行。

对于有用户验证的代理，可以通过下面的代码段配置用户名和密码：

// 创建EtClientConfiguration实例
 EtClientConfiguration config = new EtClientConfiguration();
    
 // 配置代理为本地8080端口
 config.setProxyHost("127.0.0.1");
 config.setProxyPort(8080);
    
 //设置用户名和密码
 config.setProxyUsername(<username>);                             //用户名
 config.setProxyPassword(<password>);                             //密码

设置网络参数

用户可以用EtClientConfiguration对基本网络参数进行设置：

EtClientConfiguration config = new EtClientConfiguration();
    
// 设置HTTP最大连接数为10
config.setMaxConnections(10);
    
// 设置TCP连接超时为5000毫秒
config.setConnectionTimeout(5000);
    
// 设置Socket传输数据超时的时间为2000毫秒
config.setSocketTimeout(2000);

参数说明 通过EtClientConfiguration能指定的所有参数如下表所示：

参数	说明
UserAgent	用户代理，指HTTP的User-Agent头
Protocol	连接协议类型
ProxyDomain	访问NTLM验证的代理服务器的Windows域名
ProxyHost	代理服务器主机地址
ProxyPort	代理服务器端口
ProxyUsername	代理服务器验证的用户名
ProxyPassword	代理服务器验证的密码
ProxyPreemptiveAuthenticationEnabled	是否设置用户代理认证
ProxyWorkstation	NTLM代理服务器的Windows工作站名称
LocalAddress	本地地址
ConnectionTimeoutInMillis	建立连接的超时时间（单位：毫秒）
SocketTimeoutInMillis	通过打开的连接传输数据的超时时间（单位：毫秒）
MaxConnections	允许打开的最大HTTP连接数
RetryPolicy	连接重试策略
SocketBufferSizeInBytes	Socket缓冲区大小

安装SDK工具包

专线

专线 ET