設置桶策略
更新時間 2025-06-11 14:55:22
最近更新時間: 2025-06-11 14:55:22
分享文章
接口介紹
為指定的存儲桶設置權限策略。
接口約束
支持的線上資源池 ：上海7、南京3、南京5、杭州2、合肥2、九江、廣州6、武漢4、福州25、廈門3、郴州2、海口2、北京5、雄安2、石家莊20、內蒙6、晉中、遼陽1、西安5、烏魯木齊4、烏魯木齊27、中衛5、蘭州2、西寧2、拉薩3、昆明2、重慶2、成都4、貴州3、上海33、寧波邊緣云、華東1、上海36、南昌5、青島20、武漢41、長沙42、長沙37、南寧23、北京行業云20、華北2、西南1、上海32。
URI
POST /v4/oss/put-bucket-policy
請求參數
請求體 JSON Body 參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 |
|---|---|---|---|---|
| bucket | 是 | String | 桶名 | bk1 |
| regionID | 是 | String | 區域ID | 332232eb-63aa-465e-9028-52e5123866f0 |
| policy | 是 | String | JSON文檔形式的存儲桶策略 | {"Version": "2012-10-17", "Id": "S3PolicyId1", "Statement": [{"Resource": ["arn:aws:s3:::DOC-EXAMPLE-BUCKET", "arn:aws:s3:::DOC-EXAMPLE-BUCKET/"], "Effect": "Deny", "Sid": "IPAllow", "Action": "s3:", "Condition": {"NotIpAddress": {"aws:SourceIp": "54.240.143.0/24"}}, "Principal": "*"}]} |
表 policy
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 |
|---|---|---|---|---|
| Version | 是 | String | 當前支持"2012-10-17" | 2012-10-17 |
| Id | 否 | String | 桶策略ID，桶策略的唯一標識 | policy1 |
| Statement | 是 | Array of Objects | 桶策略描述，定義完整的權限控制。每條桶策略的Statement可由多條描述組成，每條描述是一個dict，每條描述可包含以下字段： Sid Effect Principal Action ReSource Condition | 見下級對象 |
表 Statement
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 |
|---|---|---|---|---|
| Sid | 是 | String | 本條桶策略描述的ID | S3PolicyId1 |
| Effect | 是 | String | 桶策略的效果，即指定本條桶策略描述的權限是接受請求還是拒絕請求。 接受請求：配置為“Allow”， 拒絕請求：配置為“Deny” | Deny |
| Principal | 是 | Object or String | 被授權人，即指定本條桶策略描述所作用的用戶，支持通配符“*”，表示所有用戶。當對某個user進行授權時，Principal 格式為"AWS": "arn:aws:s3:::userId" | * |
| Action | 是 | String or Array of string | 操作，即指定本條桶策略描述所作用的oss操作。以列表形式表示，可配置多條操作，以逗號間隔。支持通配符”“，表示該資源能進行的所有操作。常用的Action有"s3:GetObject"，"s3:PutObject"，"s3:"等 | s3:* |
| Condition | 否 | Object | 條件語句，指定本條桶策略所限制的條件。可以通過Condition對oss資源各種策略，比如設置防盜鏈： "Condition": {"StringEquals":{"aws:Referer":["www.daliqc.cn"]}，此時如果Effect為“Allow”，則允許來自"www.daliqc.cn"的請求；如果為“Deny”，則拒絕 |
{"NotIpAddress": {"aws:SourceIp": "54.240.143.0/24"}} |
| Resource | 是 | String or Array of string | 此條策略所作用的資源，如桶、對象等 | ["arn:aws:s3:::DOC-EXAMPLE-BUCKET", "arn:aws:s3:::DOC-EXAMPLE-BUCKET/*"] |
響應參數
| 參數 | 參數類型 | 說明 | 示例 |
|---|---|---|---|
| statusCode | Integer | 返回碼 取值范圍：800 成功 |
800 |
| message | String | 狀態描述 | SUCCESS |
| description | String | 狀態描述，一般為中文 | 成功 |
| errorCode | String | 業務細分碼（僅失敗時具有此參數），為product.module.code三段式碼 | openapi.userPermission.accessFailed |
請求示例
{
"bucket": "bk1",
"regionID": "332232eb-63aa-465e-9028-52e5123866f0",
"policy": "{\"Version\": \"2012-10-17\", \"Id\": \"S3PolicyId1\", \"Statement\": [{\"Resource\": [\"arn:aws:s3:::DOC-EXAMPLE-BUCKET\", \"arn:aws:s3:::DOC-EXAMPLE-BUCKET/*\"], \"Effect\": \"Deny\", \"Sid\": \"IPAllow\", \"Action\": \"s3:*\", \"Condition\": {\"NotIpAddress\": {\"aws:SourceIp\": \"54.240.143.0/24\"}}, \"Principal\": \"*\"}]}"
}
響應示例
{
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 800 | 表示請求成功。 |
| 900 | 表示請求失敗。 |
錯誤碼
errorCode 枚舉值，見錯誤碼總表
