查询训练作业镜像保存任务 - ShowSaveImageJob
功能介绍
查询训练作业镜像保存任务接口用于获取ModelArts平台上指定训练作业的镜像保存任务信息。
该接口适用于以下场景：当用户需要查看特定训练作业的镜像保存任务状态时，可以通过此接口获取任务信息。使用该接口的前提条件是用户已知训练作业ID，并具有查看镜像保存任务的权限。查询操作完成后，平台将返回包含镜像保存任务的状态、配置等信息。若训练作业ID不存在或用户无权限操作，接口将返回相应的错误信息。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。获取该接口关联的CLI示例： hcloud ModelArts ShowSaveImageJob。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
modelarts:trainJob:get
Read
trainJob *
g:ResourceTag/<tag-key>
-
-
-
-
modelarts:poolType
-
modelarts:poolId
-
URI
GET /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"，依次类推。 取值范围：不涉及。 默认取值：不涉及。 |
请求参数
无
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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镜像保存任务为例。
GET https://endpoint/v2/{project_id}/training-jobs/2cd88daa-31a4-40a8-a58f-d186b0e93e4f/tasks/worker-0/save-image-job
响应示例
状态码：200
查询训练作业镜像保存任务成功
{
"name" : "imagesave",
"namespace" : "dev",
"tag" : 0.1,
"description" : "hello world!",
"status" : "ACTIVE",
"message" : "building",
"create_time" : 1686718209968
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询训练作业镜像保存任务成功 |
错误码
请参见错误码。
