OSSClient初始化

使用OSS域名新建OSSClient

以下代码使用OSS域名新建OSSClient。关于不同地域的OSS域名，请参见OSS地域和访问域名。

// yourEndpoint填写Bucket所在地域对应的Endpoint。以华东1（杭州）为例，Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com。
String endpoint = "yourEndpoint";

// 从环境变量中获取访问凭证。运行本代码示例之前，请先配置环境变量。
EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();

// 创建OSSClient实例。
OSS ossClient = new OSSClientBuilder().build(endpoint, credentialsProvider);

// 关闭OSSClient。
ossClient.shutdown();                    

使用自定义域名新建OSSClient

以下代码使用自定义域名新建OSSClient。关于使用自定义域名访问OSS的更多信息，请参见绑定自定义域名至Bucket默认域名。

// yourEndpoint填写自定义域名。
String endpoint = "yourEndpoint";

// 从环境变量中获取访问凭证。运行本代码示例之前，请先配置环境变量。
EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();

// 创建ClientBuilderConfiguration实例，您可以根据实际情况修改默认参数。
ClientBuilderConfiguration conf = new ClientBuilderConfiguration();

// 设置是否支持CNAME。CNAME用于将自定义域名绑定到目标Bucket。
conf.setSupportCname(true);

// 创建OSSClient实例。
OSS ossClient = new OSSClientBuilder().build(endpoint, credentialsProvider, conf);

// 关闭OSSClient。
ossClient.shutdown();                    

使用STS新建OSSClient

以下代码使用STS新建OSSClient。

• 关于搭建STS服务的具体操作，请参见使用STS临时访问凭证访问OSS。

• 您可以通过调用STS服务的AssumeRole接口或者使用各语言STS SDK来获取临时访问凭证。

• 临时访问凭证包括临时访问密钥（AccessKeyId和AccessKeySecret）和安全令牌（SecurityToken）。临时访问凭证有效时间单位为秒，最小值为900，最大值以当前角色设定的最大会话时间为准。更多信息，请参见设置RAM角色最大会话时间。

• 完整代码示例，请参见使用签名URL下载。

// yourEndpoint填写Bucket所在地域对应的Endpoint。以华东1（杭州）为例，Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com。
String endpoint = "yourEndpoint";

// 从环境变量中获取STS的访问密钥（AccessKey ID和AccessKey Secret）和安全令牌（SecurityToken）作为访问凭证。运行本代码示例之前，请先配置环境变量。
EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();

// 创建OSSClient实例。
OSS ossClient = new OSSClientBuilder().build(endpoint, credentialsProvider);

// 关闭OSSClient。
ossClient.shutdown();                    

使用STSAssumeRole新建OSSClient

以下代码使用STSAssumeRole新建OSSClient。

// 授权STSAssumeRole访问的Region。以华东1（杭州）为例，其它Region请根据实际情况填写。
String region = "cn-hangzhou";

// 从环境变量中获取RAM用户的访问密钥（AccessKeyId和AccessKeySecret）。运行本代码示例之前，请先配置环境变量。
String accessKeyId = System.getenv("ALIYUN_ACCESS_KEY_ID");
String accessKeySecret = System.getenv("ALIYUN_ACCESS_KEY_SECRET");

// 从环境变量中获取RAM角色的RamRoleArn。运行本代码示例之前，请先配置环境变量。
String roleArn = System.getenv("ALIYUN_STS_ROLE_ARN");  

// 创建STSAssumeRoleSessionCredentialsProvider实例。
STSAssumeRoleSessionCredentialsProvider credentialsProvider = CredentialsProviderFactory.newSTSAssumeRoleSessionCredentialsProvider(
region, accessKeyId, accessKeySecret, roleArn);

// yourEndpoint填写Bucket所在地域对应的Endpoint。以华东1（杭州）为例，Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com。
String endpoint = "yourEndpoint";

// 创建ClientBuilderConfiguration实例。
ClientBuilderConfiguration conf = new ClientBuilderConfiguration();

// 创建OSSClient实例。
OSS ossClient = new OSSClientBuilder().build(endpoint, credentialsProvider, conf);

// 关闭OSSClient。
ossClient.shutdown();

使用EcsRamRole新建OSSClient

在云服务器ECS上，您可以通过实例RAM角色的方式访问OSS。实例RAM角色允许您将一个角色关联到云服务器实例，在实例内部基于临时凭证STS访问OSS。临时凭证由系统自动生成和更新，应用程序可以使用指定的实例元数据URL获取临时凭证，无需特别管理。

以下代码用于使用EcsRamRole新建OSSClient。

// 以华东1（杭州）为例，其它endpoint请根据实际情况填写。
String endpoint = "https://oss-cn-hangzhou.aliyuncs.com";     

// 通过ECS RAM角色获取访问凭证，例如以角色名（ecs-ram-role）访问为例。
InstanceProfileCredentialsProvider credentialsProvider = CredentialsProviderFactory.newInstanceProfileCredentialsProvider("ecs-ram-role");

// 创建OSSClient实例。
 OSS ossClient = new OSSClientBuilder().build(endpoint, credentialsProvider, new ClientBuilderConfiguration());

// 关闭OSSClient。
ossClient.shutdown(); 

专有云或专有域环境新建OSSClient

以下代码使用专有云或专有域环境新建OSSClient。

// yourEndpoint填写Bucket所在地域对应的Endpoint。
String endpoint = "yourEndpoint";

// 从环境变量中获取访问凭证。运行本代码示例之前，请先配置环境变量。
EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();

// 创建ClientBuilderConfiguration实例，您可以根据实际情况修改默认参数。
ClientBuilderConfiguration conf = new ClientBuilderConfiguration();

// 关闭CNAME选项。
conf.setSupportCname(false);

// 创建OSSClient实例。
OSS ossClient = new OSSClientBuilder().build(endpoint, credentialsProvider, conf);

// 关闭OSSClient。
ossClient.shutdown();                    

使用IP新建OSSClient

以下代码使用IP新建OSSClient。

// 某些特殊情况（例如专有域）下，您需要将IP地址作为Endpoint使用，请根据实际IP地址填写。
String endpoint = "https://10.10.10.10";

// 从环境变量中获取访问凭证。运行本代码示例之前，请先配置环境变量。
EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();

// 创建ClientBuilderConfiguration。
ClientBuilderConfiguration conf = new ClientBuilderConfiguration();

// 开启二级域名访问OSS，默认不开启。OSS Java SDK 2.1.2及之前的版本需要设置此值，OSS Java SDK 2.1.2及之后的版本会自动检测到IP地址，不需要再设置此值。
conf.setSLDEnabled(true);

// 创建OSSClient实例。
OSS ossClient = new OSSClientBuilder().build(endpoint, credentialsProvider, conf);

// 关闭OSSClient。
ossClient.shutdown();