创建训练作业镜像保存任务 - CreateSaveImageJob
功能介绍
创建训练作业镜像保存任务接口用于为已存在的训练作业创建一个镜像保存任务。
该接口适用于以下场景：当用户需要将训练作业的当前状态或模型保存为镜像，以便后续复用或分享时，可以通过此接口创建一个镜像保存任务。使用该接口的前提条件是训练作业已存在且用户具有相应的操作权限。镜像保存任务创建成功后，系统将开始保存训练作业的镜像，并在完成后通知用户。若训练作业不存在、用户无权限操作或镜像保存任务创建失败，接口将返回相应的错误信息。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。获取该接口关联的CLI示例： hcloud ModelArts CreateSaveImageJob。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
modelarts:trainJob:create
Write
trainJob *
-
-
-
-
-
g:RequestTag/<tag-key>
-
g:TagKeys
-
modelarts:poolType
-
modelarts:poolId
-
URI
POST /v2/{project_id}/training-jobs/{training_job_id}/tasks/{task_id}/save-image-job
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释：用户项目ID。获取方法请参见获取项目ID和名称。 约束限制：1 - 64字符，字母、数字和中划线。 取值范围：不涉及。 默认取值：不涉及。 |
|
training_job_id |
是 |
String |
参数解释：训练作业ID。获取方法请参见查询训练作业列表。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
task_id |
是 |
String |
参数解释：训练作业的任务名称。可从训练作业详情中的status.tasks字段中获取。 约束限制：单节点默认为"worker-0"，多节点则为"worker-0"、"worker-1"，依次类推。 取值范围：不涉及。 默认取值：不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
否 |
String |
参数解释：镜像名称。 约束限制：长度限制512个字符，支持小写字母、数字、中划线、下划线和点。 取值范围：不涉及。 默认取值：不涉及。 |
|
namespace |
否 |
String |
参数解释：镜像所属组织，可以在SWR控制台“组织管理”创建和查看。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
tag |
否 |
String |
参数解释：镜像tag。 约束限制：长度限制64个字符， 支持大小写字母、数字、中划线、下划线和点。 取值范围：不涉及。 默认取值：不涉及。 |
|
description |
否 |
String |
参数解释：该镜像所对应的描述信息。 约束限制：长度限制512个字符。 取值范围：不涉及。 默认取值：不涉及。 |
响应参数
状态码：201
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
参数解释：镜像名称，长度限制512个字符，支持小写字母、数字、中划线、下划线和点。 取值范围：不涉及。 |
|
namespace |
String |
参数解释：镜像所属组织，可以在SWR控制台“组织管理”创建和查看。 取值范围：不涉及。 |
|
tag |
String |
参数解释：镜像tag，长度限制64个字符， 支持大小写字母、数字、中划线、下划线和点。 取值范围：不涉及。 |
|
description |
String |
参数解释：该镜像所对应的描述信息，长度限制512个字符。 取值范围：不涉及。 |
|
status |
String |
参数解释：镜像状态。 取值范围：枚举值如下：
|
|
message |
String |
参数解释：镜像创建的时间，UTC毫秒。 取值范围：不涉及。 |
|
create_time |
Long |
参数解释：镜像保存操作过程中，展示构建信息。 取值范围：不涉及。 |
请求示例
如下以创建uuid为2cd88daa-31a4-40a8-a58f-d186b0e93e4f的训练作业对应worker-0镜像保存任务为例。
POST https://endpoint/v2/{project_id}/training-jobs/2cd88daa-31a4-40a8-a58f-d186b0e93e4f/tasks/worker-0/save-image-job
{
"name" : "imagesave",
"namespace" : "dev",
"tag" : 0.1,
"description" : "hello world!"
}
响应示例
状态码：201
create image save job successfully
{
"name" : "imagesave",
"namespace" : "dev",
"tag" : 0.1,
"description" : "hello world!",
"status" : "ACTIVE",
"message" : "building",
"create_time" : 1686718209968
}
状态码
|
状态码 |
描述 |
|---|---|
|
201 |
create image save job successfully |
错误码
请参见错误码。
