設置對象保留期限配置
更新時間 2025-06-11 14:55:27
最近更新時間: 2025-06-11 14:55:27
分享文章
接口介紹
設置對象的合規保留策略,在保留周期內的對象不可被徹底刪除和篡改。
接口約束
- 需要在創建桶時啟用合規保留配置。
- 支持的線上資源池 :上海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-object-retention
請求參數
請求體 JSON Body 參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 |
|---|---|---|---|---|
| bucket | 是 | String | 桶名 | bucket1 |
| regionID | 是 | String | 區域 ID | 332232eb-63aa-465e-9028-52e5123866f0 |
| key | 是 | String | 對象名稱 | obj1 |
| versionID | 是 | String | 版本ID,在開啟多版本時可使用 | USzD.sN0vODAsQ84ncdT20oRiY2lFCD |
| bypassGovernanceRetention | 是 | Boolean | 指示此操作是否應繞過Governance模式限制 | true |
| retentionMode | 是 | String | 保留模式,必須為?COMPLIANCE 或?GOVERNANCE | COMPLIANCE |
| retainUntilDate | 是 | Integer | 保留截止日期, utc 時間戳,單位秒,距當前時刻不超過 70 年(按1年365天計) | 1667114769 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 |
|---|---|---|---|
| statusCode | Integer | 返回碼 取值范圍:800 成功 |
800 |
| message | String | 狀態描述 | SUCCESS |
| description | String | 狀態描述,一般為中文 | 成功 |
| errorCode | String | 業務細分碼(僅失敗時具有此參數),為product.module.code三段式碼 | openapi.userPermission.accessFailed |
請求示例
{
"bucket": "bucket1",
"regionID": "332232eb-63aa-465e-9028-52e5123866f0",
"key": "obj1",
"versionID": "USzD.sN0vODAsQ84ncdT20oRiY2lFCD",
"bypassGovernanceRetention": true,
"retentionMode": "COMPLIANCE",
"retainUntilDate": 1667114769
}
響應示例
{
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 800 | 表示請求成功。 |
| 900 | 表示請求失敗。 |
錯誤碼
errorCode 枚舉值,見錯誤碼總表