简介
本文档提供关于对象的删除操作相关的 API 概览以及 SDK 示例代码。
API | 操作名 | 操作描述 |
删除单个对象 | 在存储桶中删除指定对象 |
删除单个对象
功能说明
删除指定的对象(DELETE Object)。
示例代码
// 存储桶名称,由 bucketname-appid 组成,appid 必须填入,可以在 COS 控制台查看存储桶名称。 https://console.cloud.tencent.com/cos5/bucketlet bucket = "examplebucket-1250000000";// 存储桶所在地域简称,例如广州地区是 ap-guangzhoulet region = "COS_REGION";//对象在存储桶中的位置标识符,即对象键let cosPath = "exampleobject";try {await Cos.getDefaultService().deleteObject(bucket, cosPath, undefined, region);} catch (e) {// 失败后会抛异常 根据异常进行业务处理console.log(e);}
参数说明
参数名称 | 描述 | 类型 | 是否必选 |
bucket | 桶名称,Bucket 的命名规则为 BucketName-APPID,详情请参见 存储桶概述 | String | 是 |
cosPath | 对象键 是对象在存储桶中的唯一标识。例如,在对象的访问域名 examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/doc/picture.jpg 中,对象键为 doc/picture.jpg | String | 是 |
versionId | 指定要删除的版本 ID | String | 否 |
返回结果说明
成功:无返回值。
失败:发生错误(如身份认证失败),抛出异常 CosXmlClientError 或者 CosXmlServiceError。详情请参见 异常处理。