对象存储
有奖：腾讯混元大模型征文大赛邀您参加！> HOT
文档中心>对象存储>SDK 文档>.NET(C#) SDK>对象操作>生成预签名 URL

生成预签名 URL

最近更新时间：2024-08-13 17:46:41

我的收藏

本页目录：

简介

本文档提供关于生成对象预签名链接的示例代码。
关于使用预签名 URL 上传的说明请参见 预签名授权上传， 使用预签名 URL 下载的说明请参见 预签名授权下载。

注意事项

2024年1月1日后创建的桶 不支持使用默认域名在浏览器预览文件，建议您配置自定义域名，详情请参见 存储桶切换自定义域名。
建议用户使用临时密钥生成预签名，通过临时授权的方式进一步提高预签名上传、下载等请求的安全性。申请临时密钥时，请遵循 最小权限指引原则，防止泄露目标存储桶或对象之外的资源。
如果您一定要使用永久密钥来生成预签名，建议永久密钥的权限范围仅限于上传或下载操作，以规避风险。
关于临时密钥的获取，请参见 临时密钥生成及使用指引。

相关示例

功能名称
描述
示例代码
生成预签名 URL
对象存储（Cloud Object Storage，COS）支持使用预签名 URL 进行对象的上传、下载，原理是将签名嵌入 URL 生成签名链接。

前期准备：初始化 COS 服务实例

public class DownloadObject
{
    private CosXml cosXml; //将服务用户设置成数据成员
    // 初始化COS服务实例
    private void InitCosXml()
    {
        string region = Environment.GetEnvironmentVariable("COS_REGION");
        CosXmlConfig config = new CosXmlConfig.Builder()
            .SetRegion(region) // 设置默认的地域, COS 地域的简称请参照 https://cloud.tencent.com/document/product/436/6224
            .Build();
        string secretId = Environment.GetEnvironmentVariable("SECRET_ID"); // 云 API 密钥 SecretId, 获取 API 密钥请参照 https://console.cloud.tencent.com/cam/capi
        string secretKey = Environment.GetEnvironmentVariable("SECRET_KEY"); // 云 API 密钥 SecretKey, 获取 API 密钥请参照 https://console.cloud.tencent.com/cam/capi
        long durationSecond = 600; //每次请求签名有效时长，单位为秒
        QCloudCredentialProvider qCloudCredentialProvider = new DefaultQCloudCredentialProvider(secretId, secretKey, durationSecond);
        this.cosXml = new CosXmlServer(config, qCloudCredentialProvider);
    }
}

使用案例

生成预签名 URL

public void GetPreSignDownloadUrl()
{
    try
    {
        PreSignatureStruct preSignatureStruct = new PreSignatureStruct();
        preSignatureStruct.appid = appId;//"1250000000"; //腾讯云账号 APPID
        preSignatureStruct.region = region;//"COS_REGION"; //存储桶地域
        preSignatureStruct.bucket = bucket;// "examplebucket-1250000000"; //存储桶
        preSignatureStruct.key = "exampleObject"; //对象键
        preSignatureStruct.httpMethod = "GET"; //HTTP 请求方法
        preSignatureStruct.isHttps = true; //生成 HTTPS 请求 URL
        preSignatureStruct.signDurationSecond = 600; //请求签名时间为600s
        preSignatureStruct.headers = null; //签名中需要校验的 header
        preSignatureStruct.queryParameters = null; //签名中需要校验的 URL 中请求参数
        string requestSignURL = cosXml.GenerateSignURL(preSignatureStruct);
        Console.WriteLine(requestSignURL);
        
        //下载请求预签名 URL (使用永久密钥方式计算的签名 URL)
        string localDir = System.IO.Path.GetTempPath(); //本地文件夹
        string localFileName = "my-local-temp-file"; //指定本地保存的文件名
        GetObjectRequest request = new GetObjectRequest(null, null, localDir, localFileName);
        //设置下载请求预签名 URL
        request.RequestURLWithSign = requestSignURL;
        //设置进度回调
        request.SetCosProgressCallback(delegate(long completed, long total)
        {
            Console.WriteLine(String.Format("progress = {0:##.##}%", completed * 100.0 / total));
        });
        //执行请求
        GetObjectResult result = cosXml.GetObject(request);
        //请求成功
        Console.WriteLine(result.GetResultInfo());
    }
    catch (COSXML.CosException.CosClientException clientEx)
    {
        Console.WriteLine("CosClientException: " + clientEx);
    }
    catch (COSXML.CosException.CosServerException serverEx)
    {
        Console.WriteLine("CosServerException: " + serverEx.GetInfo());
    }
}

生成预签名上传链接

public void GetPreSignUploadUrl()
{
    try
    {
        PreSignatureStruct preSignatureStruct = new PreSignatureStruct();
        // APPID 获取参考 https://console.cloud.tencent.com/developer
        preSignatureStruct.appid = appId;//"1250000000";
        // 存储桶所在地域, COS 地域的简称请参照 https://cloud.tencent.com/document/product/436/6224
        preSignatureStruct.region = region;//"COS_REGION";
        // 存储桶名称，此处填入格式必须为 bucketname-APPID, 其中 APPID 获取参考 https://console.cloud.tencent.com/developer
        preSignatureStruct.bucket = bucket;//"examplebucket-1250000000";
        preSignatureStruct.key = "exampleObject"; //对象键
        preSignatureStruct.httpMethod = "PUT"; //HTTP 请求方法
        preSignatureStruct.isHttps = true; //生成 HTTPS 请求 URL
        preSignatureStruct.signDurationSecond = 600; //请求签名时间为 600s
        preSignatureStruct.headers = null; //签名中需要校验的 header
        preSignatureStruct.queryParameters = null; //签名中需要校验的 URL 中请求参数
        //上传预签名 URL (使用永久密钥方式计算的签名 URL)
        string requestSignURL = cosXml.GenerateSignURL(preSignatureStruct);
        Console.WriteLine(requestSignURL);
        
        string srcPath = @"local-file-path"; //本地文件绝对路径
        PutObjectRequest request = new PutObjectRequest(null, null, srcPath);
        //设置上传请求预签名 URL
        request.RequestURLWithSign = requestSignURL;
        //设置进度回调
        request.SetCosProgressCallback(delegate(long completed, long total)
        {
            Console.WriteLine(String.Format("progress = {0:##.##}%", completed * 100.0 / total));
        });
        //执行请求
        PutObjectResult result = cosXml.PutObject(request);
        //请求成功
        Console.WriteLine(result.GetResultInfo());
    }
    catch (COSXML.CosException.CosClientException clientEx)
    {
        Console.WriteLine("CosClientException: " + clientEx);
    }
    catch (COSXML.CosException.CosServerException serverEx)
    {
        Console.WriteLine("CosServerException: " + serverEx.GetInfo());
    }
}

生成预签名 URL，并在签名中携带 Host

public void GetPreSignUrlWithHost()
{
    try
    {
        PreSignatureStruct preSignatureStruct = new PreSignatureStruct();
        // APPID 获取参考 https://console.cloud.tencent.com/developer
        preSignatureStruct.appid = "1250000000";
        // 存储桶所在地域, COS 地域的简称请参照 https://cloud.tencent.com/document/product/436/6224
        preSignatureStruct.region = "COS_REGION";
        // 存储桶名称，此处填入格式必须为 bucketname-APPID, 其中 APPID 获取参考 https://console.cloud.tencent.com/developer
        preSignatureStruct.bucket = "examplebucket-1250000000";
        preSignatureStruct.key = "exampleobject"; //对象键
        preSignatureStruct.httpMethod = "GET"; //HTTP 请求方法
        preSignatureStruct.isHttps = true; //生成 HTTPS 请求 URL
        preSignatureStruct.signDurationSecond = 600; //请求签名时间为600s
        preSignatureStruct.signHost = true; // 请求中签入Host，建议开启，能够有效防止越权请求，需要注意，开启后实际请求也需要携带Host请求头
        preSignatureStruct.headers = null; //签名中需要校验的 header
        preSignatureStruct.queryParameters = null; //签名中需要校验的 URL 中请求参数

        string requestSignURL = cosXml.GenerateSignURL(preSignatureStruct);
        Console.WriteLine("requestUrl is:" + requestSignURL);
        
        //下载请求预签名 URL (使用永久密钥方式计算的签名 URL)
        string localDir = System.IO.Path.GetTempPath(); //本地文件夹
        string localFileName = "my-local-temp-file"; //指定本地保存的文件名
        GetObjectRequest request = new GetObjectRequest(null, null, localDir, localFileName);
        //设置下载请求预签名 URL
        request.RequestURLWithSign = requestSignURL;
        //设置进度回调
        request.SetCosProgressCallback(delegate(long completed, long total)
        {
            Console.WriteLine(String.Format("progress = {0:##.##}%", completed * 100.0 / total));
        });
        //执行请求
        GetObjectResult result = cosXml.GetObject(request);
        //请求成功
        Console.WriteLine(result.GetResultInfo());
    }
    catch (COSXML.CosException.CosClientException clientEx)
    {
        Console.WriteLine("CosClientException: " + clientEx);
    }
    catch (COSXML.CosException.CosServerException serverEx)
    {
        Console.WriteLine("CosServerException: " + serverEx.GetInfo());
    }
}

生成预签名URL，并在签名中携带请求参数

public void GetPreSignUrlWithReqParam()
{
    try
    {
        PreSignatureStruct preSignatureStruct = new PreSignatureStruct();
        // APPID 获取参考 https://console.cloud.tencent.com/developer
        preSignatureStruct.appid = "1250000000";
        // 存储桶所在地域, COS 地域的简称请参照 https://cloud.tencent.com/document/product/436/6224
        preSignatureStruct.region = "COS_REGION";
        // 存储桶名称，此处填入格式必须为 bucketname-APPID, 其中 APPID 获取参考 https://console.cloud.tencent.com/developer
        preSignatureStruct.bucket = "examplebucket-1250000000";
        preSignatureStruct.key = "exampleobject"; //对象键
        preSignatureStruct.httpMethod = "GET"; //HTTP 请求方法
        preSignatureStruct.isHttps = true; //生成 HTTPS 请求 URL
        preSignatureStruct.signDurationSecond = 600; //请求签名时间为600s
        preSignatureStruct.signHost = true; // 请求中签入Host，建议开启，能够有效防止越权请求，需要注意，开启后实际请求也需要携带Host请求头
        preSignatureStruct.headers = null; // 签名中需要校验的 header
        string ci_params = "imageMogr2/thumbnail/!50p";
        preSignatureStruct.queryParameters = new Dictionary<string, string>(); // 签名中需要校验的 URL 中请求参数，以请求万象图片处理为例
        preSignatureStruct.queryParameters.Add(ci_params, null);

        string requestSignURL = cosXml.GenerateSignURL(preSignatureStruct);
        Console.WriteLine("requestUrl is:" + requestSignURL);

        //下载请求预签名 URL (使用永久密钥方式计算的签名 URL)
        string localDir = System.IO.Path.GetTempPath(); //本地文件夹
        string localFileName = "my-local-temp-file"; //指定本地保存的文件名
        GetObjectRequest request = new GetObjectRequest(null, null, localDir, localFileName);
        //设置下载请求预签名 URL
        request.RequestURLWithSign = requestSignURL;
        //设置进度回调
        request.SetCosProgressCallback(delegate(long completed, long total)
        {
            Console.WriteLine(String.Format("progress = {0:##.##}%", completed * 100.0 / total));
        });
        //执行请求
        GetObjectResult result = cosXml.GetObject(request);
        //请求成功
        Console.WriteLine(result.GetResultInfo());
    }
    catch (COSXML.CosException.CosClientException clientEx)
    {
        Console.WriteLine("CosClientException: " + clientEx);
    }
    catch (COSXML.CosException.CosServerException serverEx)
    {
        Console.WriteLine("CosServerException: " + serverEx.GetInfo());
    }
}
中国站
文档反馈
文档活动
message-icon联系我们
目录