接口介绍
批量删除对象。
接口约束
支持的线上资源池 ：上海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 枚举值，见错误码总表
