創建策略
更新時間 2025-06-11 14:55:29
最近更新時間: 2025-06-11 14:55:29
分享文章
接口介紹
創建策略
接口約束
支持的線上資源池 ：合肥2、西安5
URI
POST /v4/oss/create-policy
請求參數
請求體 JSON Body 參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 |
|---|---|---|---|---|
| regionID | 是 | String | 區域ID | 332232eb-63aa-465e-9028-52e5123866f0 |
| policyName | 是 | String | 策略名稱 | policy1 |
| policyDocument | 是 | String | JSON 文檔形式的策略 | - |
| note | 否 | String | 備注 | some notes |
表 policyDocument
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 |
|---|---|---|---|---|
| Version | 是 | String | 當前支持"2012-10-17" | 2012-10-17 |
| Statement | 是 | Array of Objects | 桶策略描述，定義完整的權限控制。每條桶策略的Statement可由多條描述組成，每條描述是一個dict，每條描述可包含以下字段： Sid Effect Principal Action ReSource Condition | 見下級對象 |
表 Statement
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 |
|---|---|---|---|---|
| Sid | 否 | String | 本條桶策略描述的ID | S3PolicyId1 |
| Effect | 是 | String | 桶策略的效果，即指定本條桶策略描述的權限是接受請求還是拒絕請求。 接受請求：配置為“Allow”， 拒絕請求：配置為“Deny” | Deny |
| Action | 是 | String | 操作，即指定本條桶策略描述所作用的oss操作。以列表形式表示，可配置多條操作，以逗號間隔。支持通配符”“，表示該資源能進行的所有操作。常用的Action有"s3:GetObject"，"s3:PutObject"，"s3: "等 | s3:* |
| Condition | 否 | String | 條件語句，指定本條桶策略所限制的條件。可以通過Condition對oss資源各種策略。 | {"NotIpAddress": {"aws:SourceIp": "54.240.143.0/24"}} |
| Resource | 是 | String | 此條策略所作用的資源，如桶、對象等。根據需要本參數也可使用Array of Strings類型 | ["arn:aws:s3:::DOC-EXAMPLE-BUCKET", "arn:aws:s3:::DOC-EXAMPLE-BUCKET/*"] |
響應參數
| 參數 | 參數類型 | 說明 | 示例 |
|---|---|---|---|
| statusCode | Long | 返回碼 取值范圍：800 成功 |
800 |
| message | String | 狀態描述 | SUCCESS |
| returnObj | Object | 響應對象 | 見下級對象 |
| description | String | 狀態描述，一般為中文 | 成功 |
| errorCode | String | 業務細分碼（僅失敗時具有此參數），為product.module.code三段式碼 | openapi.userPermission.accessFailed |
| error | String | 業務細分碼（大駝峰形式，僅失敗時具有此參數），為 Product.Module.Code 三段式碼 | Openapi.UserPermission.AccessFailed |
請求示例
{
"regionID":"332232eb-63aa-465e-9028-52e5123866f0",
"policyName":"policy1",
"policyDocument":"
{
\"Version\": \"2012-10-17\",
\"Statement\":
[
{
\"Action\":
[
\"s3:GetObject\",
\"s3:PutObject\",
\"s3:AbortMultipartUpload\",
\"s3:DeleteObject\",
\"s3:DeleteObjectVersion\",
\"s3:RestoreObject\"
],
\"Resource\": \"arn:aws:s3:::YOUR-BUCKET-NAME/*\",
\"Effect\": \"Allow\"
}
]
}
"
}
響應示例
{
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 800 | 表示請求成功。 |
| 900 | 表示請求失敗。 |
錯誤碼
errorCode 枚舉值，見錯誤碼總表
