Java initialization

Create an OSSClient using the OSS domain name

The following code creates an OSSClient using the OSS domain name. For OSS domain names in different regions, see Access domain name and data center 。

 //YourEndpoint fills in the endpoint corresponding to the bucket's region. Taking East China 1 (Hangzhou) as an example, the Endpoint is filled in as https://oss-cn-hangzhou.aliyuncs.com 。 String endpoint = "yourEndpoint"; //Get access credentials from environment variables. Please configure the environment variables before running this code example. EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider(); //Create an OSSClient instance. OSS ossClient = new OSSClientBuilder().build(endpoint,  credentialsProvider); //Close the OSSClient. ossClient.shutdown();

Create a new OSSClient using a custom domain name

The following code creates an OSSClient using a custom domain name. For more information about using a custom domain name to access OSS, see Bind the custom domain name to the bucket default domain name 。

 //YourEndpoint fills in the custom domain name. String endpoint = "yourEndpoint"; //Get access credentials from environment variables. Please configure the environment variables before running this code example. EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider(); //Create a ClientBuilderConfiguration instance, and you can modify the default parameters according to the actual situation. ClientBuilderConfiguration conf = new ClientBuilderConfiguration(); //Set whether CNAME is supported. CNAME is used to bind a custom domain name to the target bucket. conf.setSupportCname(true); //Create an OSSClient instance. OSS ossClient = new OSSClientBuilder().build(endpoint,  credentialsProvider, conf); //Close the OSSClient. ossClient.shutdown();

Create an OSSClient using STS

The following code uses STS to create a new OSSClient.

• Please refer to Use STS temporary access credentials to access OSS 。

• You can call the STS service's AssumeRole Interface or use STS SDK in all languages To obtain temporary access credentials.

• Temporary access credentials include temporary access keys (AccessKeyId and AccessKeySecret) and security tokens (SecurityToken). The valid time unit of temporary access credentials is seconds, the minimum value is 900, and the maximum value is subject to the maximum session time set by the current role. For more information, see Set the maximum session time of RAM role 。

• For a complete code example, see Authorized access 。

 //YourEndpoint fills in the endpoint corresponding to the bucket's region. Taking East China 1 (Hangzhou) as an example, the Endpoint is filled in as https://oss-cn-hangzhou.aliyuncs.com 。 String endpoint = "yourEndpoint"; //Obtain the access key (AccessKey ID and AccessKey Secret) and security token (SecurityToken) of STS from the environment variable as the access credential. Please configure the environment variables before running this code example. EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider(); //Create an OSSClient instance. OSS ossClient = new OSSClientBuilder().build(endpoint,  credentialsProvider); //Close the OSSClient. ossClient.shutdown();

Use STSAssumeRole to create a new OSSClient

The following code uses STSAssumeRole to create a new OSSClient.

 //The region that STSAssumeRole is authorized to access. Take East China 1 (Hangzhou) as an example. Please fill in other regions according to the actual situation. String region = "cn-hangzhou"; //Obtain the access key (AccessKeyId and AccessKeySecret) of the RAM user from the environment variable. Please configure the environment variables before running this code example. String accessKeyId = System.getenv("ALIYUN_ACCESS_KEY_ID"); String accessKeySecret = System.getenv("ALIYUN_ACCESS_KEY_SECRET"); //Get RamRoleArn of RAM role from environment variable. Please configure the environment variables before running this code example. String roleArn = System.getenv("ALIYUN_STS_ROLE_ARN");   //Create an instance of STSAssumeRoleSessionCredentialsProvider. STSAssumeRoleSessionCredentialsProvider credentialsProvider = CredentialsProviderFactory.newSTSAssumeRoleSessionCredentialsProvider( region, accessKeyId, accessKeySecret, roleArn); //YourEndpoint fills in the endpoint corresponding to the bucket's region. Taking East China 1 (Hangzhou) as an example, the Endpoint is filled in as https://oss-cn-hangzhou.aliyuncs.com 。 String endpoint = "yourEndpoint"; //Create a ClientBuilderConfiguration instance. ClientBuilderConfiguration conf = new ClientBuilderConfiguration(); //Create an OSSClient instance. OSS ossClient = new OSSClientBuilder().build(endpoint,  credentialsProvider, conf); //Close the OSSClient. ossClient.shutdown();

Use EcsRamRole to create a new OSSClient

On ECS, you can access OSS through the instance RAM role. The instance RAM role allows you to associate a role with an ECS instance and access OSS within the instance based on the temporary voucher STS. Temporary vouchers are automatically generated and updated by the system. Applications can use the specified instance metadata URL to obtain temporary vouchers without special management.

The following code is used to create a new OSSClient using EcsRamRole.

 //Take East China 1 (Hangzhou) as an example. Please fill in other endpoints according to the actual situation. String endpoint = " https://oss-cn-hangzhou.aliyuncs.com ";      //Access credentials are obtained through ECS RAM roles. For example, take the role name (ecs ram role) access as an example. InstanceProfileCredentialsProvider credentialsProvider = CredentialsProviderFactory.newInstanceProfileCredentialsProvider("ecs-ram-role"); //Create an OSSClient instance. OSS ossClient = new OSSClientBuilder().build(endpoint, credentialsProvider, new ClientBuilderConfiguration()); //Close the OSSClient. ossClient.shutdown();

Create a new OSSClient in a VPC or VPC domain environment

The following code creates an OSSClient using a private cloud or a private domain environment.

 //YourEndpoint fills in the endpoint corresponding to the bucket's region. String endpoint = "yourEndpoint"; //Get access credentials from environment variables. Please configure the environment variables before running this code example. EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider(); //Create a ClientBuilderConfiguration instance, and you can modify the default parameters according to the actual situation. ClientBuilderConfiguration conf = new ClientBuilderConfiguration(); //Turn off the CNAME option. conf.setSupportCname(false); //Create an OSSClient instance. OSS ossClient = new OSSClientBuilder().build(endpoint,  credentialsProvider, conf); //Close the OSSClient. ossClient.shutdown();

Create a new OSSClient using IP

The following code uses IP to create a new OSSClient.

 //In some special cases (such as private domain), you need to use the IP address as an endpoint. Please fill in according to the actual IP address. String endpoint = " https://10.10.10.10 "; //Get access credentials from environment variables. Please configure the environment variables before running this code example. EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider(); //Create ClientBuilderConfiguration. ClientBuilderConfiguration conf = new ClientBuilderConfiguration(); //Enable the secondary domain name to access OSS. It is not enabled by default. The OSS Java SDK 2.1.2 and earlier versions need to set this value. The OSS Java SDK 2.1.2 and later versions will automatically detect the IP address, and do not need to set this value again. conf.setSLDEnabled(true); //Create an OSSClient instance. OSS ossClient = new OSSClientBuilder().build(endpoint,  credentialsProvider, conf); //Close the OSSClient. ossClient.shutdown();