删除资产 - DeleteAsset
功能介绍
删除资产接口用于在ModelArts平台上删除指定的资产,支持通过forceDelete参数对数据集类型资产进行强制删除。
该接口适用于以下场景:当用户需要清理不再使用的资产或释放存储资源时,可以通过此接口进行删除。使用该接口的前提条件是用户已具备项目访问权限,并已知目标资产的ID。平台将在校验资产存在性、归属权限及使用状态后执行禁用删除操作并返回资产ID。若资产不存在、为预置资产不可删除、模型资产仍在使用中或用户无权限操作,接口将返回相应的错误信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
DELETE /v2/{project_id}/assets/{asset_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释:华为云项目ID,[获取项目ID]在ModelArts Studio任意页面,按F12进入开发者工具,刷新页面,在开发者工具Network页签找到/rest/me接口,从此接口的response里找到project_id字段。 约束限制:1-64字符,英文字母,数字,下划线,中划线。 取值范围:不涉及。 默认取值:不涉及。 |
| asset_id | 是 | String | 参数解释:资产id。 约束限制:1-36字符,英文字母,数字,下划线,中划线。 取值范围:不涉及。 默认取值:不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| workspace_id | 否 | String | 参数解释:工作空间ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 约束限制:1-32字母,数字。 取值范围:不涉及。 默认取值:不涉及。 |
| force_delete | 否 | Boolean | 参数解释:数据集资产是否删除OBS桶中的数据,boolean类型,取值true:删除OBS桶中的数据,取值false:仅删除记录不删除OBS桶中的数据。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释:用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,[获取Token]调用IAM的/v3/auth/tokens,在接口响应消息头中X-Subject-Token的值即为Token。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| asset_id | String | 参数解释:资产id。 取值范围:不涉及。 |
请求示例
https://{endpoint}/v2/{project_id}/assets/{asset_id} 响应示例
状态码:200
删除资产
{
"asset_id" : "ae637b99211766277942cd98b340b3c6"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 删除资产 |
错误码
请参见错误码。