Object Storage Service:Initialization

Create an OSSClient instance by using an OSS endpoint

The following code provides an example on how to create an OSSClient instance by using an OSS endpoint.

// Specify the endpoint of the region in which the bucket is located. For example, if the bucket is located in the China (Hangzhou) region, set the endpoint to https://oss-cn-hangzhou.aliyuncs.com. 
String endpoint = "yourEndpoint";
// The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in OSS is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O&M. To create a RAM user, log on to the RAM console. 
String accessKeyId = "yourAccessKeyId";
String accessKeySecret = "yourAccessKeySecret";

// Create an OSSClient instance. 
OSS ossClient = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret);

// Shut down the OSSClient instance. 
ossClient.shutdown();                    

Create an OSSClient instance by using a custom domain name

The following code provides an example on how to create an OSSClient instance by using a custom domain name.

For more information about how to use a custom domain name to access OSS, see Map custom domain names.

// Set yourEndpoint to the custom domain name that you want to use. 
String endpoint = "yourEndpoint";
// The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in OSS is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O&M. To create a RAM user, log on to the RAM console. 
String accessKeyId = "yourAccessKeyId";
String accessKeySecret = "yourAccessKeySecret";

// Create a ClientConfiguration instance and modify the default parameters based on your business requirements. 
ClientBuilderConfiguration conf = new ClientBuilderConfiguration();
// Specify whether to use CNAME. CNAME is used to map the custom domain name to the bucket. 
conf.setSupportCname(true);

// Create an OSSClient instance. 
OSS ossClient = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret, conf);

// Shut down the OSSClient instance. 
ossClient.shutdown();                    

Create an OSSClient instance based on Apsara Stack or a private region

The following code provides an example on how to create an OSSClient instance based on Apsara Stack or a private region:

// Specify the endpoint of the region in which the bucket is located. 
String endpoint = "yourEndpoint";
// The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in OSS is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O&M. To create a RAM user, log on to the RAM console. 
String accessKeyId = "yourAccessKeyId";
String accessKeySecret = "yourAccessKeySecret";

// Create a ClientConfiguration instance and modify the default parameters based on your business requirements. 
ClientBuilderConfiguration conf = new ClientBuilderConfiguration();
// Disable CNAME. 
conf.setSupportCname(false);

// Create an OSSClient instance. 
OSS ossClient = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret, conf);

// Shut down the OSSClient instance. 
ossClient.shutdown();                    

Create an OSSClient instance based on an IP address

The following code provides an example on how to create an OSSClient instance based on an IP address:

// In special cases, such as cases that involve a private region, an IP address is used as an endpoint. In these cases, you must specify the actual IP address. 
String endpoint = "https://10.10.10.10";
// The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in OSS is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O&M. To create a RAM user, log on to the RAM console. 
String accessKeyId = "yourAccessKeyId";
String accessKeySecret = "yourAccessKeySecret";

// Create a ClientConfiguration instance. 
ClientBuilderConfiguration conf = new ClientBuilderConfiguration();
// Enable access from a second-level domain because access from a second-level domain is disabled by default. OSS SDK for Java V2.1.2 or later automatically detects IP addresses. If you use OSS SDK for Java whose version is earlier than V2.1.2, you must configure this parameter. 
conf.setSLDEnabled(true);

// Create an OSSClient instance. 
OSS ossClient = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret, conf);

// Shut down the OSSClient instance. 
ossClient.shutdown();                    

Create an OSSClient instance by using STS

The following code provides an example on how to create an OSSClient instance by using Security Token Service (STS):

// Specify the endpoint of the region in which the bucket is located. For example, if the bucket is located in the China (Hangzhou) region, set the endpoint to https://oss-cn-hangzhou.aliyuncs.com. 
String endpoint = "yourEndpoint";
// Specify the temporary AccessKey pair obtained from STS. 
String accessKeyId = "yourAccessKeyId";
String accessKeySecret = "yourAccessKeySecret";
// Specify the security token obtained from STS. 
String securityToken = "yourSecurityToken";

// Create an OSSClient instance. 
OSS ossClient = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret, securityToken);

// Shut down the OSSClient instance. 
ossClient.shutdown();                    

For more information, see Authorized access.

Create an OSSClient instance by using STSAssumeRole

The following code provides an example on how to create an OSSClient by using STSAssumeRole:

// Specify the region that STSAssumeRole can access. In this example, the China (Hangzhou) region is used. Specify this parameter based on the actual region. 
String region = "cn-hangzhou";
// Specify the AccessKey pair of the RAM user. 
String accessKeyId = "yourAccessKeyId";
String accessKeySecret = "yourAccessKeySecret";
// Specify the Alibaba Cloud Resource Name (ARN) of STSAssumeRole, which indicates the ID of the role. Format: acs:ram::$accountID:role/$roleName. 
// $accountID indicates the Alibaba Cloud account ID. To view the Alibaba Cloud account ID, perform the following steps: Log on to the OSS console, and move the pointer over the profile picture in the upper-right corner to view and copy the account ID, or click Basic Information to view the account ID. 
// $roleName indicates the name of the RAM role. To view the RAM role name, perform the following steps: Log on to the RAM console. In the left-side navigation pane, choose Identities > Roles. On the page that appears, view the name in the Role Name column. 
String roleArn = "acs:ram::17464958********:role/ossststest";   
// Create an STSAssumeRoleSessionCredentialsProvider instance. 
STSAssumeRoleSessionCredentialsProvider provider = CredentialsProviderFactory.newSTSAssumeRoleSessionCredentialsProvider(
region, accessKeyId, accessKeySecret, roleArn);
// Specify the endpoint of the region in which the bucket is located. For example, if the bucket is located in the China (Hangzhou) region, set the endpoint to https://oss-cn-hangzhou.aliyuncs.com. 
String endpoint = "yourEndpoint";
// Create a ClientConfiguration instance. 
ClientBuilderConfiguration conf = new ClientBuilderConfiguration();

 
// Create an OSSClient instance. 
OSS ossClient = new OSSClientBuilder().build(endpoint, provider, conf);

// Shut down the OSSClient instance. 
ossClient.shutdown();

For more information, see Use temporary credentials provided by STS to access OSS.

Create an OSSClient instance by using EcsRamRole

You can access OSS from an Elastic Compute Service (ECS) instance by using a RAM role attached to the instance. You can attach a RAM role to an ECS instance to access OSS from the instance by using temporary access credentials that are obtained from STS. STS temporary access credentials are automatically generated and updated. Applications can obtain STS temporary access credentials by using the instance metadata URL.

The following code provides an example on how to create an OSSClient by using EcsRamRole:

// Use the EcsRamRole role to access OSS. 
// In this example, the endpoint of the China (Hangzhou) region is used. Specify your actual endpoint. 
String endpoint = "https://oss-cn-hangzhou.aliyuncs.com";     

// Use EcsRamRole to obtain temporary access credentials. The following code shows how to obtain temporary access credentials by using a role named ecs-ram-role. 
InstanceProfileCredentialsProvider provider = CredentialsProviderFactory.newInstanceProfileCredentialsProvider("ecs-ram-role");

// Create an OSSClient instance. 
 OSS ossClient = new OSSClientBuilder().build(endpoint, provider, new ClientBuilderConfiguration());

// Shut down the OSSClient instance. 
ossClient.shutdown();