Object Storage Service:Use temporary access credentials provided by STS to access OSS

Java

import com.aliyun.oss.*;
import com.aliyun.oss.common.auth.CredentialsProvider;
import com.aliyun.oss.common.auth.DefaultCredentialProvider;
import com.aliyun.oss.common.comm.SignVersion;
import com.aliyun.oss.model.PutObjectRequest;
import com.aliyun.oss.model.PutObjectResult;

import java.io.File;

public class Demo {

    public static void main(String[] args) throws Exception {
        // Specify the temporary AccessKey ID, AccessKey secret and STS token generated in step 1.5. Do not use the credentials of a RAM user.
        // Take note that the AccessKey ID provided by STS starts with STS.
        String accessKeyId = "yourSTSAccessKeyID";
        String accessKeySecret = "yourSTSAccessKeySecret";
        // Specify the security token obtained from STS.
        String stsToken= "yourSecurityToken";

        // Pass the AccessKey ID and secret to DefaultCredentialProvider to initialize the credential provider.
        CredentialsProvider credentialsProvider = new DefaultCredentialProvider(accessKeyId, accessKeySecret, stsToken);
        // Use credentialsProvider to initialize the client.
        ClientBuilderConfiguration clientBuilderConfiguration = new ClientBuilderConfiguration();
        // Explicitly declare the use of the V4 signature algorithm.
        clientBuilderConfiguration.setSignatureVersion(SignVersion.V4);
        // Create an OSSClient instance.
        OSS ossClient = OSSClientBuilder.create()
                 // 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.  
                .endpoint("endpoint")
                .credentialsProvider(credentialsProvider)
                .clientConfiguration(clientBuilderConfiguration)
                // Specify the region ID. Example: cn-hangzhou.
                .region("region")
                .build();

        try {

            // Create a PutObjectRequest object. Upload the local file exampletest.txt to examplebucket.
            PutObjectRequest putObjectRequest = new PutObjectRequest("examplebucket", "exampletest.txt", new File("D:\\localpath\\exampletest.txt"));

            // Optional. Specify the storage class and ACL of the object.
            // ObjectMetadata metadata = new ObjectMetadata();
            // metadata.setHeader(OSSHeaders.OSS_STORAGE_CLASS, StorageClass.Standard.toString());
            // metadata.setObjectAcl(CannedAccessControlList.Private);
            // putObjectRequest.setMetadata(metadata);

            // Upload the object. 
            PutObjectResult result = ossClient.putObject(putObjectRequest);
        } catch (OSSException oe) {
            System.out.println("Caught an OSSException, which means your request made it to OSS, "
                    + "but was rejected with an error response for some reason.");
            System.out.println("Error Message:" + oe.getErrorMessage());
            System.out.println("Error Code:" + oe.getErrorCode());
            System.out.println("Request ID:" + oe.getRequestId());
            System.out.println("Host ID:" + oe.getHostId());
        } catch (ClientException ce) {
            System.out.println("Caught an ClientException, which means the client encountered "
                    + "a serious internal problem while trying to communicate with OSS, "
                    + "such as not being able to access the network.");
            System.out.println("Error Message:" + ce.getMessage());
        } finally {
            if (ossClient != null) {
                ossClient.shutdown();
            }
        }
    }
}

Python

OSS SDK for Python is available in 2 versions, 2.0 and 1.0. OSS SDK for Python 2.0 is a complete refactoring of 1.0, streamlining core operations such as authentication, request retries, and error handling. It offers more flexible parameter configurations and introduces new advanced features. The following examples are provided to help you implement OSS SDK for Python based on your actual requirements.

import alibabacloud_oss_v2 as oss

def main():
    # Specify the temporary AccessKey ID, AccessKey secret and STS token generated in step 1.5. Do not use the credentials of a RAM user.
    # Take note that the AccessKey ID provided by STS starts with STS.
    sts_access_key_id = 'yourSTSAccessKeyID'
    sts_access_key_secret = 'yourSTSAccessKeySecret'
    # Specify the STS token obtained from STS.
    sts_security_token = 'yourSecurityToken'
    
    # Create a static credential provider and explicitly specify the AccessKey ID, AccessKey secret, and STS token provided by STS.
    credentials_provider = oss.credentials.StaticCredentialsProvider(
        access_key_id=sts_access_key_id,
        access_key_secret=sts_access_key_secret,
        security_token=sts_security_token,
    )

    # Load the default configuration of the SDK and specify the credential provider.
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider

    # Specify the region in which the bucket is located. For example, if the bucket is located in the China (Hangzhou) region, set the region to cn-hangzhou.
    cfg.region = 'cn-hangzhou'

    # Use the preceding configurations to create an OSSClient instance.
    client = oss.Client(cfg)

    # Specify the full path of the local object that you want to upload.  Example: D:\\localpath\\exampletest.txt.
    local_file_path = 'D:\\localpath\\exampletest.txt'
    with open(local_file_path, 'rb') as file:
        data = file.read()

    # Execute the request to upload exampletest.txt to examplebucket. 
    result = client.put_object(oss.PutObjectRequest(
        # Name of the bucket.
        bucket='examplebucket',
        # Name of the object to upload. 
        key='exampletest.txt',
        body=data,
    ))

     # Display the HTTP status code, request ID, MD5 hash, ETag, CRC-64 value, and object version ID to check whether the request is successful.
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          f' content md5: {result.content_md5},'
          f' etag: {result.etag},'
          f' hash crc64: {result.hash_crc64},'
          f' version id: {result.version_id},'
    )


# Call the main function when the script is directly run.
if __name__ == "__main__":
    main()  # The entry point of the script. When the script is directly run, the main function is called.

# -*- coding: utf-8 -*-
import oss2

# 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. 
endpoint = 'https://oss-cn-hangzhou.aliyuncs.com'
# Specify the temporary AccessKey ID and AccessKey secret that were generated in step 1.5. Do not use the AccessKey ID and AccessKey secret of an Alibaba Cloud account. 
sts_access_key_id = 'yourAccessKeyId'
sts_access_key_secret = 'yourAccessKeySecret'
# Specify the name of the bucket. 
bucket_name = 'examplebucket'
# Specify the full path of the object by using a string. Do not include the bucket name in the full path.  
object_name = 'examplebt.txt'
# Enter the STS token generated in Step 1.5. 
security_token = 'yourSecurityToken'
# Initialize the StsAuth instance by using the temporary access credentials. 
auth = oss2.StsAuth(sts_access_key_id,
                    sts_access_key_secret,
                    security_token)
# Initialize the bucket by using the StsAuth instance. 
bucket = oss2.Bucket(auth, endpoint, bucket_name)
# Upload the object. 
result = bucket.put_object(object_name, "hello world")
print(result.status)

Go

OSS SDK for Go is available in 2 versions, 2.0 and 1.0. OSS SDK for Go 2.0 is a complete refactoring of 1.0, streamlining core operations such as authentication, request retries, and error handling. It offers more flexible parameter configurations and introduces new advanced features. The following examples are provided to help you implement OSS SDK for Go based on your actual requirements.

package main

import (
	"context"
	"log"

	"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss"
	"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss/credentials"
)

func main() {
	// Specify the region in which the bucket is located. For example, if the bucket is located in the China (Hangzhou) region, set the region to cn-hangzhou.
	region := "cn-hangzhou"

	// Specify the temporary AccessKey ID, AccessKey secret and STS token generated in step 1.5. Do not use the credentials of a RAM user.
        // Take note that the AccessKey ID provided by STS starts with STS.
	accessKeyID := "yourSTSAccessKeyID"
	accessKeySecret := "yourSTSAccessKeySecret"
	// Specify the STS token obtained from STS.
	stsToken := "yourSecurityToken"

	// Use the NewStaticCredentialsProvider method to specify the AccessKey ID, AccessKey secret and STS Token.
	provider := credentials.NewStaticCredentialsProvider(accessKeyID, accessKeySecret, stsToken)

	// Load the default configuration of the SDK and specify the credential provider and region.
	cfg := oss.LoadDefaultConfig().
		WithCredentialsProvider(provider).
		WithRegion(region)

	// Create an OSS client.
	client := oss.NewClient(cfg)

	// Specify the path of the local file that you want to upload. Example: D:\\localpath\\exampletest.txt.
	localFile := "D:\\localpath\\exampletest.txt"

	// Create a request to upload an object.
	putRequest := &oss.PutObjectRequest{
		Bucket:       oss.Ptr("examplebucket"),      // Name of the bucket.
		Key:          oss.Ptr("exampletest.txt"),    // name of the obejct to upload.
		StorageClass: oss.StorageClassStandard, // Set the storage class of the object to Standard.
		Acl:          oss.ObjectACLPrivate,     // Set the ACL of the object to private.
		Metadata: map[string]string{
			"yourMetadataKey1": "yourMetadataValue1", // Configure the metadata of the object.
		},
	}

	// Execute the request to upload exampletest.txt to examplebucket.
	result, err := client.PutObjectFromFile(context.TODO(), putRequest, localFile)
	if err != nil {
		log.Fatalf("failed to put object from file %v", err)
	}

	// Display the result of the object upload.
	log.Printf("put object from file result:%#v\n", result)
	
}

package main

import (
    "fmt""github.com/aliyun/aliyun-oss-go-sdk/oss""os"
)

func main() {
    // Obtain the temporary access credentials from the environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID, OSS_ACCESS_KEY_SECRET, and OSS_SESSION_TOKEN environment variables are configured.
    provider, err := oss.NewEnvironmentVariableCredentialsProvider()
    if err != nil {
        fmt.Println("Error:", err)
        os.Exit(-1)
    }
    // Create an OSSClient instance. // 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. Specify your actual endpoint.
    client, err := oss.New("yourEndpoint", "", "", oss.SetCredentialsProvider(&provider))
    if err != nil {
        fmt.Println("Error:", err)
        os.Exit(-1)
    }
    // Specify the name of the bucket. Example: examplebucket.
    bucketName := "examplebucket"// Specify the full path of the object. Do not include the bucket name in the full path. Example: exampledir/exampleobject.txt.
    objectName := "exampledir/exampleobject.txt"// Specify the full path of the local object. Example: D:\\localpath\\examplefile.txt.
    filepath := "D:\\localpath\\examplefile.txt"
    bucket,err := client.Bucket(bucketName)
    // Upload the local file by using the temporary access credentials.
    err = bucket.PutObjectFromFile(objectName,filepath)
    if err != nil {
        fmt.Println("Error:", err)
        os.Exit(-1)
    }
    fmt.Println("upload success")
}

Node.js

const axios = require("axios");
const OSS = require("ali-oss");

// Use the temporary access credentials to initialize an OSSClient instance. The instance is used to authorize temporary access to OSS resources.
const getToken = async () => {
  // Specify the address that is used by the client to obtain the temporary access credentials.
  await axios.get("http://localhost:8000/sts").then((token) => {
    const client = new OSS({
       // Specify the region in which the bucket is located. For example, if the bucket is located in the China (Hangzhou) region, set the region to oss-cn-hangzhou.
      region: 'oss-cn-hangzhou',
      // Specify the temporary AccessKey ID, AccessKey secret and STS token generated in step 1.5. Do not use the credentials of a RAM user.
      accessKeyId: token.data.AccessKeyId,
      accessKeySecret: token.data.AccessKeySecret,
      // Enter the STS token generated in Step 1.5.
      stsToken: token.data.SecurityToken,
      authorizationV4: true,
      // Specify the name of the bucket.
      bucket: "examplebucket",
      // Refresh the temporary access credentials.
      refreshSTSToken: async () => {
        const refreshToken = await axios.get("http://localhost:8000/sts");
        return {
          accessKeyId: refreshToken.data.AccessKeyId,
          accessKeySecret: refreshToken.data.AccessKeySecret,
          stsToken: refreshToken.data.SecurityToken,
        };
      },
    });
    // Use the temporary access credentials to upload an object.
    // Specify the full path of the object. Do not include the bucket name in the full path. Example: exampleobject.jpg.
    // Specify the full path of the local object. Example: D:\\example.jpg.
    client.put('exampleobject.jpg', 'D:\\example.jpg').then((res)=>{console.log(res)}).catch(e=>console.log(e))
  });
};
getToken()

php

<?php
if (is_file(__DIR__ . 'autoload.php')) {
    require_once __DIR__ . 'autoload.php';
}
if (is_file(__DIR__ . '/vendor/autoload.php')) {
    require_once __DIR__ . '/vendor/autoload.php';
}

use OSS\Credentials\StaticCredentialsProvider;
use OSS\OssClient;
use OSS\Core\OssException;

try {
    // Specify the temporary AccessKey ID, AccessKey secret and STS token generated in step 1.5. Do not use the credentials of a RAM user.
    // Take note that the AccessKey ID provided by STS starts with STS.
    $accessKeyId = 'yourSTSAccessKeyID';
    $accessKeySecret = 'yourSTSAccessKeySecret';
    // Specify the STS token obtained from STS.
    $securityToken = 'yourSecurityToken';

    // Create a credential provider by using StaticCredentialsProvider.
    $provider = new StaticCredentialsProvider($accessKeyId, $accessKeySecret, $securityToken);

    // 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.
    $endpoint = "https://oss-cn-hangzhou.aliyuncs.com";

    // Specify the name of the bucket. Example: examplebucket.
    $bucket= "examplebucket";
    // Specify the name of the object to upload.
    $object = "exampletest.txt";
    // Specify the full path of the local object that you want to upload. Example: D:\\localpath\\exampletest.txt.
    $localFilePath = "D:\\localpath\\exampletest.txt";

    // You can configure headers in upload requests to specify information about the uploaded string. For example, you can set the object ACL to private and configure the user metadata of the object.
    $options = array(
        OssClient::OSS_HEADERS => array(
            'x-oss-object-acl' => 'private',
            'x-oss-meta-info' => 'yourinfo'
        ),
    );

    $config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        // Specify the region in which the bucket is located. For example, if your bucket is located in the China (Hangzhou) region, set the region to cn-hangzhou.
        "region" => "cn-hangzhou"
    );
    
    // Use the preceding configurations to create an OSSClient instance.
    $ossClient = new OssClient($config);
    
     // Send the request to upload the local file named exampletest.txt to examplebucket.
    $ossClient->putObject($bucket, $object, $localFilePath, $options);
} catch (OssException $e) {
    printf($e->getMessage() . "\n");
    return;
}

Ruby

require 'aliyun/sts'
require 'aliyun/oss'

client = Aliyun::OSS::Client.new(
  # In this example, the endpoint of the China (Hangzhou) region is used. Specify your actual endpoint. 
  endpoint: 'https://oss-cn-hangzhou.aliyuncs.com',
  # Specify the temporary AccessKey ID and AccessKey secret that were generated in step 1.5. Do not use the AccessKey ID and AccessKey secret of an Alibaba Cloud account.  
  access_key_id: 'token.access_key_id',
  access_key_secret: 'token.access_key_secret',
  # Enter the STS token generated in Step 1.5. 
  sts_token: 'token.security_token'
  )
# Specify the name of the bucket. Example: examplebucket. 
bucket = client.get_bucket('examplebucket')
# Upload the object. 
bucket.put_object('exampleobject.txt', :file => 'D:\test.txt')