批量刪除對象
更新時間 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/delete-objects
請求參數
請求體 JSON Body 參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 |
|---|---|---|---|---|
| bucket | 是 | String | 桶名 | bucket1 |
| regionID | 是 | String | 區域 ID | 332232eb-63aa-465e-9028-52e5123866f0 |
| delete | 是 | Object | 要刪除的對象 |
表 delete
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 |
|---|---|---|---|---|
| objects | 是 | Array of Objects | 對象的數組 | |
| quiet | 否 | Boolean | 靜默模式,默認 false。若為 true, 則響應不會返回每個對象的刪除結果,僅返回失敗的結果 | true |
表 objects
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 |
|---|---|---|---|---|
| key | 是 | String | 對象名 | obj1 |
| versionID | 否 | String | 版本ID,在開啟多版本時可使用 | Mp6FKCm7LkZvCA3iTWj6sdqv.4vLAFS |
響應參數
| 參數 | 參數類型 | 說明 | 示例 |
|---|---|---|---|
| returnObj | Object | 響應對象 | 見下級對象 |
| statusCode | Integer | 返回碼 取值范圍:800 成功 |
800 |
| message | String | 狀態描述 | SUCCESS |
| description | String | 狀態描述,一般為中文 | 成功 |
| errorCode | String | 業務細分碼(僅失敗時具有此參數),為product.module.code三段式碼 | openapi.userPermission.accessFailed |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 |
|---|---|---|---|
| deleted | Array of Objects | ||
| requestCharged | String | 如果存在,則表明請求者已成功為請求收費。 | requester |
| errors | Array of Objects | 刪除失敗的信息 |
表 deleted
| 參數 | 參數類型 | 說明 | 示例 |
|---|---|---|---|
| key | String | 對象名 | obj2 |
| versionID | String | 版本ID,在開啟多版本時可使用 | Mp6FKCm7LkZvCA3iTWj6sdqv.4vLAFS |
| deleteMarker | Boolean | 指定永久刪除的版本化對象是 (true) 還是不是 (false) 刪除標記。在簡單的 DELETE 中,此標頭指示是否 (true) 或不 (false) 創建了刪除標記 | true |
| deleteMarkerVersionID | String | 作為DELETE操作的結果而創建的刪除標記的版本ID。如果你刪除一個特定的對象版本,這個頭返回的值是被刪除的對象版本的版本ID | Mp6FKCm7LkZvCA3iTWj6sdqv.4vLAFS |
表 errors
| 參數 | 參數類型 | 說明 | 示例 |
|---|---|---|---|
| key | String | 對象名 | obj3 |
| versionID | String | 版本ID,在開啟多版本時可使用 | NU6FKCm7LkvydingTWj6sdqv.32LAFS |
| code | String | 錯誤碼 | NoSuchVersion |
| message | String | 錯誤消息 | Indicates that the version ID specified in the request does not match an existing version |
請求示例
{
"bucket": "bucket1",
"regionID": "332232eb-63aa-465e-9028-52e5123866f0",
"delete": {
"objects": [
{
"key": "obj1",
"versionID": "Mp6FKCm7LkZvCA3iTWj6sdqv.4vLAFS"
},
{
"key": "obj2",
"versionID": "NU6FKCm7LkvydingTWj6sdqv.32LAFS"
}
],
"quiet": true
}
}
響應示例
{
"returnObj": {
"deleted": [
{
"key": "obj1",
"versionID": "Mp6FKCm7LkZvCA3iTWj6sdqv.4vLAFS",
"deleteMarker": true,
"deleteMarkerVersionID": "Mp6FKCm7LkZvCA3iTWj6sdqv.4vLAFS"
}
],
"requestCharged": "requester",
"errors": [
{
"key": "obj2",
"versionID": "NU6FKCm7LkvydingTWj6sdqv.32LAFS",
"code": "NoSuchVersion",
"message": "Indicates that the version ID specified in the request does not match an existing version"
}
]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 800 | 表示請求成功。 |
| 900 | 表示請求失敗。 |
錯誤碼
errorCode 枚舉值,見錯誤碼總表