批量删除训练作业 - BatchDeleteTrainingJob
功能介绍
批量删除训练作业接口用于一次性从ModelArts平台上移除多个已创建的训练作业。
该接口适用于以下场景:当用户需要集中清理多个已完成或不再需要的训练作业时,可以通过此接口批量删除,避免逐个调用删除接口。使用该接口的前提条件是待删除的训练作业均已存在、属于同一工作空间,且用户具有删除训练作业的权限。删除操作完成后,训练作业将从平台中永久移除,相关资源和配置也将被清理。若待删除作业数量超过100、作业不存在、作业不属于同一工作空间或用户无权限操作,接口将返回相应的错误信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v2/{project_id}/training-jobs/batch-delete
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释:用户项目ID。获取方法请参见获取项目ID和名称。 约束限制:不涉及。 取值范围:1 - 64字符,字母、数字和中划线。 默认取值:不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| jobs | 是 | Array of BatchDeleteJobItem objects | 参数解释:待删除的训练作业列表。 约束限制:列表元素数量不超过100,且所有作业必须属于同一工作空间。 取值范围:不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| kind | 是 | String | 参数解释:训练作业类型。 取值范围: |
| metadata | 是 | BatchDeleteJobMetadata object | 批量删除训练作业时所需的作业元数据。 |
响应参数
状态码:202
No Content
无
请求示例
如下以批量删除训练作业为例,一次删除两个作业。
POST https://{endpoint}/v2/{project_id}/training-jobs/batch-delete
{
"jobs" : [ {
"kind" : "job",
"metadata" : {
"id" : "3faf5c03-aaa1-4cbe-879d-24b05d997347"
}
}, {
"kind" : "job",
"metadata" : {
"id" : "4a0b6d14-bb22-5cf9-980e-35c16e00845f"
}
} ]
} 响应示例
状态码:202
No Content
""
状态码
| 状态码 | 描述 |
|---|---|
| 202 | No Content |
错误码
请参见错误码。