简介
本文档提供关于存储桶策略的 API 概览以及 SDK 示例代码。
注意事项
需要 COS C# SDK v5.4.39 及以上版本。
相关示例
功能名称 | 描述 | 示例代码 |
设置存储桶策略 | 设置指定存储桶的权限策略 | |
查询存储桶策略 | 查询指定存储桶的权限策略 | |
删除存储桶策略 | 删除指定存储桶的权限策略 |
前期准备:初始化 COS 服务实例
public class AccessManageModel { 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); } }
使用案例
设置存储桶策略
PUT Bucket policy 请求可以向 Bucket 写入权限策略,当存储桶已存在权限策略时,该请求上传的策略将覆盖原有的权限策略。
public void PutBucketPolicy() {string bucket = "examplebucket-1250000000"; PutBucketPolicyRequest request = new PutBucketPolicyRequest(bucket); string policy = @"{ ""Statement"": [ { ""Action"": [ ""name/cos:PutBucketPolicy"", ""name/cos:GetBucketPolicy"", ""name/cos:DeleteBucketPolicy"" ], ""Effect"": ""Allow"", ""Principal"": { ""qcs"": [ ""qcs::cam::uin/100000000001:uin/100000000002"" ] }, ""Resource"": [ ""qcs::cos:ap-guangzhou:uid/1250000000:examplebucket-1250000000/*"" ] } ], ""Version"": ""2.0"" }"; request.SetBucketPolicy(policy); PutBucketPolicyResult result = cosXml.PutBucketPolicy(request); Console.WriteLine(result.GetResultInfo()); }
参数说明
参数名称 | 描述 | 必填 |
Statement | 描述一条或多条权限的详细信息 | 是 |
Version | 策略语法版本,默认为2.0 | 是 |
Principal | 是 | |
Action | 此处是指 COS API,根据需求指定一个或者一序列操作的组合或所有操作( * ),例如 action 为 name/cos:GetService ,请注意区分英文大小写 | 是 |
Effect | 有 allow(允许)和 deny(显式拒绝)两种情况 | 是 |
Resource | 授权操作的具体数据,可以是任意资源、指定路径前缀的资源、指定绝对路径的资源或它们的组合 | 是 |
Condition | 否 |
查询存储桶策略
GET Bucket policy 请求可以向 Bucket 读取权限策略。
public void GetBucketPolicy() {string bucket = "examplebucket-1250000000"; GetBucketPolicyRequest request = new GetBucketPolicyRequest(bucket); GetBucketPolicyResult result = cosXml.GetBucketPolicy(request); Console.WriteLine(result.Data); //返回数据,json格式 Console.WriteLine(result.GetResultInfo()); }
删除存储桶策略
DELETE Bucket policy 请求可以向 Bucket 删除权限策略。
public void DeleteBucketPolicy() {string bucket = "examplebucket-1250000000"; DeleteBucketPolicyRequest request = new DeleteBucketPolicyRequest(bucket); DeleteBucketPolicyResult result = cosXml.DeleteBucketPolicy(request); Console.WriteLine(result.GetResultInfo()); }
API 操作
关于设置存储桶策略的 API 接口说明,请参见 PUT Bucket policy 文档。
关于查询存储桶策略的 API 接口说明,请参见 GET Bucket policy 文档。
关于删除存储桶策略的 API 接口说明,请参见 DELETE Bucket policy 文档。