tencent cloud

使用 AWS S3 SDK 访问 COS
下载PDF
最后更新时间：2025-01-24 13:11:01
使用 AWS S3 SDK 访问 COS
最后更新时间： 2025-01-24 13:11:01
下载PDF

简介

对象存储（Cloud Object Storage，COS）提供了 AWS S3 兼容的 API，因此当您的数据从 S3 迁移到 COS 之后，只需要进行简单的配置修改，即可让您的客户端应用轻松兼容 COS 服务。本文主要介绍不同开发平台的 S3 SDK 的适配步骤。在完成添加适配步骤后，您就可以使用 S3 SDK 的接口来访问 COS 上的文件了。

准备工作

您已 注册腾讯云账号，并且从 访问管理控制台 上获取了腾讯云密钥 SecretID 与 SecretKey。
您已有一个集成了 S3 SDK，并能正常运行的客户端应用。

Android

下面以 AWS Android SDK 2.14.2 版本为例，介绍如何适配以便访问 COS 服务。对于终端访问 COS，将永久密钥放到客户端代码中有极大的泄露风险，我们建议您接入 STS 服务获取临时密钥，详情请参见 临时密钥生成及使用指引。

初始化

初始化实例时，您需要设置临时密钥提供者和 Endpoint，以存储桶所在地域是 ap-guangzhou 为例：
AmazonS3Client s3 = new AmazonS3Client(new AWSCredentialsProvider() {
    @Override
    public AWSCredentials getCredentials() {
         // 这里后台请求 STS 得到临时密钥信息
        return new BasicSessionCredentials(
                "<TempSecretID>", "<TempSecretKey>", "<STSSessionToken>"
        );
    }

    @Override
    public void refresh() {
        //
    }
});

s3.setEndpoint("cos.ap-guangzhou.myqcloud.com");

iOS

以 AWS iOS SDK 2.10.2 版本为例，介绍如何适配以便访问 COS 服务。对于终端访问 COS，将永久密钥放到客户端代码中有极大的泄露风险，我们建议您接入 STS 服务获取临时密钥，详情请参见 临时密钥生成及使用指引。

1. 实现 AWS CredentialsProvider 协议

-(AWSTask<AWSCredentials *> *)credentials{
    // 这里后台请求 STS 得到临时密钥信息
    AWSCredentials *credential = [[AWSCredentials alloc]initWithAccessKey:@"<TempSecretID>" secretKey:@"<TempSecretKey>" sessionKey:@"<STSSessionToken>" expiration:[NSDate dateWithTimeIntervalSince1970:1565770577]];

    return [AWSTask taskWithResult:credential];

}

- (void)invalidateCachedTemporaryCredentials{

}

2. 提供临时密钥提供者和 Endpoint

以存储桶所在地域是 ap-guangzhou 为例：
NSURL* bucketURL = [NSURL URLWithString:@"https://cos.ap-guangzhou.myqcloud.com"];

AWSEndpoint* endpoint = [[AWSEndpoint alloc] initWithRegion:AWSRegionUnknown service:AWSServiceS3 URL:bucketURL];
AWSServiceConfiguration* configuration = [[AWSServiceConfiguration alloc] 
    initWithRegion:AWSRegionUSEast2 endpoint:endpoint 
    credentialsProvider:[MyCredentialProvider new]]; // MyCredentialProvider 实现了 AWSCredentialsProvider 协议

[[AWSServiceManager defaultServiceManager] setDefaultServiceConfiguration:configuration];

Node.js

下面以 AWS JS SDK 2.509.0 版本为例，介绍如何适配以便访问 COS 服务。

初始化

初始化实例时设置腾讯云密钥和 Endpoint，以存储桶所在地域是 ap-guangzhou 为例，代码示例如下：
var AWS = require('aws-sdk');

AWS.config.update({
    accessKeyId: "COS_SECRETID",
    secretAccessKey: "COS_SECRETKEY",
    region: "ap-guangzhou",
    endpoint: 'https://cos.ap-guangzhou.myqcloud.com',
});

s3 = new AWS.S3({apiVersion: '2006-03-01'});

Java

下面以 AWS Java SDK 1.11.609 版本为例，介绍如何适配以便访问 COS 服务。

1. 修改 AWS 配置和证书文件

说明
下面以 Linux 为例，修改 AWS 配置和证书文件。
AWS SDK 的默认配置文件通常在用户目录下，可以参考 配置和证书文件。
在配置文件（文件位置是 ~/.aws/config）中添加以下配置信息：
[default]  
s3 =  
    addressing_style = virtual
在证书文件（文件位置是 ~/.aws/credentials）中配置腾讯云的密钥： 
[default]  
aws_access_key_id = [COS_SECRETID]  
aws_secret_access_key = [COS_SECRETKEY]

2. 代码中设置 Endpoint

以存储桶所在地域是 ap-guangzhou 为例，代码示例如下：
AmazonS3 s3Client = AmazonS3ClientBuilder.standard()
    .withEndpointConfiguration(new AwsClientBuilder.EndpointConfiguration(
            "http://cos.ap-guangzhou.myqcloud.com", 
            "ap-guangzhou"))
    .build();
如果您是使用 V2版本的 AWS Java SDK，代码示例如下：
S3Client s3Client = S3Client.builder()                
              .endpointOverride(URI.create("http://cos.ap-guangzhou.myqcloud.com"))                
              .region(Region.of("ap-guangzhou"))                
              .build();

Python

下面以 AWS Python SDK 1.9.205 版本为例，介绍如何适配以便访问 COS 服务。

1. 修改 AWS 配置和证书文件

说明
下面以 Linux 为例，修改 AWS 配置和证书文件。
AWS SDK 的默认配置文件通常在用户目录下，可以参考 配置和证书文件。
在配置文件（文件位置是 ~/.aws/config） 中添加以下配置：
[default]  
s3 =   
  signature_version = s3
  addressing_style = virtual
在证书文件（文件位置是 ~/.aws/credentials）中配置腾讯云的密钥： 
[default]  
aws_access_key_id = [COS_SECRETID]  
aws_secret_access_key = [COS_SECRETKEY]

2. 代码中设置 Endpoint

以存储桶所在地域是 ap-guangzhou 为例，代码示例如下：
client = boto3.client('s3', endpoint_url='https://cos.ap-guangzhou.myqcloud.com')

PHP

下面以 AWS PHP SDK 3.109.3 版本为例，介绍如何适配以便访问 COS 服务。

1. 修改 AWS 配置和证书文件

说明
下面以 Linux 为例，修改 AWS 配置和证书文件。
AWS SDK 的默认配置文件通常在用户目录下，可以参考 配置和证书文件。
在配置文件（文件位置是 ~/.aws/config） 中添加以下配置：
[default]  
s3 =  
    addressing_style = virtual
在证书文件（文件位置是 ~/.aws/credentials）中配置腾讯云的密钥： 
[default]  
aws_access_key_id = [COS_SECRETID]  
aws_secret_access_key = [COS_SECRETKEY]

2. 代码中设置 Endpoint

以存储桶所在地域是 ap-guangzhou 为例：
$S3Client = new S3Client([
  'region'          => 'ap-guangzhou',
  'version'         => '2006-03-01',
  'endpoint'        => 'https://cos.ap-guangzhou.myqcloud.com'
]);


.NET

下面以 AWS .NET SDK 3.3.104.12 版本为例，介绍如何适配以便访问 COS 服务。

初始化

初始化实例时设置腾讯云密钥和 Endpoint，以存储桶所在地域是 ap-guangzhou 为例：
string sAccessKeyId = "COS_SECRETID";
string sAccessKeySecret = "COS_SECRETKEY";
string region = "ap-guangzhou";

var config = new AmazonS3Config() { ServiceURL = "https://cos." + region + ".myqcloud.com" };
var client = new AmazonS3Client(sAccessKeyId, sAccessKeySecret, config);


Go

aws-sdk-go

下面以 AWS Go SDK 1.21.9 版本为例，介绍如何适配以便访问 COS 服务。

1. 根据密钥创建 session

以存储桶所在地域是 ap-guangzhou 为例：
func newSession() (*session.Session, error) {
    creds := credentials.NewStaticCredentials("COS_SECRETID", "COS_SECRETKEY", "")
    region := "ap-guangzhou"
    endpoint := "http://cos.ap-guangzhou.myqcloud.com"
    config := &aws.Config{
        Region:           aws.String(region),
        Endpoint:         &endpoint,
        S3ForcePathStyle: aws.Bool(true),
        Credentials:      creds,
        // DisableSSL:       &disableSSL,
    }
    return session.NewSession(config)
}

2. 根据 session 创建 server 发起请求

sess, _ := newSession()
service := s3.New(sess)

// 以上传文件为例
fp, _ := os.Open("yourLocalFilePath")
defer fp.Close()

ctx, cancel := context.WithTimeout(context.Background(), time.Duration(30)*time.Second)
defer cancel()

service.PutObjectWithContext(ctx, &s3.PutObjectInput{
    Bucket: aws.String("examplebucket-1250000000"),
    Key:    aws.String("exampleobject"),
    Body:   fp,
})

aws-sdk-go-v2

下面以 aws-sdk-go-v2 版本的上传对象为例，介绍如何适配以便访问 COS 服务。
package main

import (
        "context"
        "fmt"
        "github.com/aws/aws-sdk-go-v2/aws"
        "github.com/aws/aws-sdk-go-v2/config"
        "github.com/aws/aws-sdk-go-v2/credentials"
        "github.com/aws/aws-sdk-go-v2/service/s3"
        "os"
        "strings"
)

func main() {
        // 通过环境变量 SECRETID 和 SECRETKEY 获取密钥
        creds := credentials.NewStaticCredentialsProvider(os.Getenv("SECRETID"), os.Getenv("SECRETKEY"), "") //密钥
        customResolver := aws.EndpointResolverWithOptionsFunc(func(service, region string, options ...interface{}) (aws.Endpoint, error) {
                return aws.Endpoint{
                        PartitionID:   "aws",
                        URL:           "http://cos.ap-guangzhou.myqcloud.com",
                        SigningRegion: "ap-guangzhou",
                }, nil

        })

        cfg, _ := config.LoadDefaultConfig(
                context.TODO(),

                config.WithCredentialsProvider(creds),
                config.WithEndpointResolverWithOptions(customResolver))

        s3Client := s3.NewFromConfig(cfg, func(o *s3.Options) {
                o.UsePathStyle = false    // 使用virtual-host的方式访问
        })

        input := &s3.PutObjectInput{
                Body:         strings.NewReader("xxxxxxx"),
                Bucket:       aws.String("test-1250000000"), //存储桶名
                Key:          aws.String("test"),            //对象键
                StorageClass: "STANDARD",
        }

        result, err := s3Client.PutObject(context.Background(), input)
        if err != nil {
                panic(err)
        }
        fmt.Println(result)


C++

下面以 AWS C++ SDK 1.7.68 版本为例，介绍如何适配以便访问 COS 服务。

1. 修改 AWS 配置和证书文件

说明
下面以 Linux 为例，修改 AWS 配置和证书文件。
AWS SDK 的默认配置文件通常在用户目录下，可以参考 配置和证书文件。
在配置文件（文件位置是 ~/.aws/config） 中添加以下配置：
[default]  
s3 =  
    addressing_style = virtual
在证书文件（文件位置是 ~/.aws/credentials）中配置腾讯云的密钥： 
[default]  
aws_access_key_id = [COS_SECRETID]  
aws_secret_access_key = [COS_SECRETKEY]

2. 代码中设置 Endpoint

以存储桶所在地域是 ap-guangzhou 为例，代码示例如下：
Aws::Client::ClientConfiguration awsCC;
awsCC.scheme = Aws::Http::Scheme::HTTP;
awsCC.region = "ap-guangzhou";
awsCC.endpointOverride = "cos.ap-guangzhou.myqcloud.com"; 
Aws::S3::S3Client s3_client(awsCC);

本页内容是否解决了您的问题？
您也可以 联系销售 或 提交工单 以寻求帮助。
是
否

文档反馈