更新训练作业 - ChangeTrainingJobDescription

功能介绍

更新训练作业接口用于修改已存在的训练作业的描述、事件通知、作业优先级、允许被抢占等信息。

该接口适用于以下场景：当用户需要更新训练作业的描述、事件通知、作业优先级、允许被抢占等信息时，可以通过此接口进行修改。使用该接口的前提条件是训练作业已存在且用户具有相应的权限。更新操作完成后，训练作业的描述、事件通知、作业优先级、允许被抢占等信息将被更新。若训练作业不存在或用户无权限操作，接口将返回相应的错误信息。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。

如果使用身份策略授权，需具备如下身份策略权限。

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
modelarts:trainJob:update	Write	trainJob *	g:ResourceTag/<tag-key>	-	-
modelarts:trainJob:update	Write	-	modelarts:poolType modelarts:poolId	-	-

URI

PUT /v2/{project_id}/training-jobs/{training_job_id}

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：用户项目ID。获取方法请参见获取项目ID和名称。约束限制：不涉及。取值范围：1 - 64字符，字母、数字和中划线。默认取值：不涉及。
training_job_id	是	String	参数解释：训练作业ID。获取方法请参见查询训练作业列表。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
description	否	String	参数解释：对训练作业的描述。约束限制：长度限制为[0, 256]。取值范围：不涉及。默认取值：默认为“NULL”。
spec	否	spec object	参数解释：训练作业规格参数。约束限制：不涉及。
endpoints	否	JobEndpointsReq object	参数解释：远程接入训练作业时需要的相关配置。约束限制：不涉及。
metadata	否	metadata object	参数解释：训练作业元信息。约束限制：不涉及。

表3 spec
参数	是否必选	参数类型	描述
notification	否	Notification object	参数解释：训练事件的消息通知。约束限制：不涉及。
schedule_policy	否	schedule_policy object	参数解释：训练作业调度策略。约束限制：不涉及。

表4 Notification
参数	是否必选	参数类型	描述
topic_urn	否	String	参数解释：消息通知服务中所选主题的URN唯一资源标识。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
events	否	Array of strings	参数解释：触发消息通知的训练事件。约束限制：枚举值： JobStarted：作业开始 JobCompleted：作业结束 JobFailed：作业失败 JobTerminated：作业终止 JobRestarted：作业重启 JobHanged：作业卡死 JobPreempted：作业抢占

表5 schedule_policy
参数	是否必选	参数类型	描述
priority	否	Integer	参数解释：训练作业优先级。约束限制：仅使用专属资源池训练时才支持设置训练作业优先级。作业优先级取值为1~3，默认优先级为1，最高优先级为3。默认用户权限可选择优先级1和2，配置了“设置作业为高优先级权限”的用户可选择优先级1~3。取值范围：1-3 默认取值：不涉及。
preemptible	否	Boolean	参数解释：是否可以被抢占。约束限制：不涉及。取值范围： true：可以被抢占 false：不可以被抢占默认取值：不涉及。

表6 JobEndpointsReq
参数	是否必选	参数类型	描述
ssh	否	SSHReq object	参数解释：SSH连接信息。约束限制：不涉及。

表7 SSHReq
参数	是否必选	参数类型	描述
key_pair_names	否	Array of strings	参数解释：SSH密钥对名称，可以在云服务器控制台（ECS）“密钥对”页面创建和查看。约束限制：不涉及。

表8 metadata
参数	是否必选	参数类型	描述
annotation	否	Map<String,String>	参数解释：训练作业高级功能配置。可选取值如下： "jupyter-lab/enable": "true"（JupyterLab训练应用程序）约束限制：不涉及。

响应参数

状态码：200

无

请求示例

如下以修改uuid为3faf5c03-aaa1-4cbe-879d-24b05d997347的训练作业为例。修改成功后再调用查询训练作业接口即可看到description已被修改。

PUT https://{endpoint}/v2/{project_id}/training-jobs/3faf5c03-aaa1-4cbe-879d-24b05d997347

{
  "description" : "hahaha"
}

响应示例

状态码：200

null

状态码

状态码	描述
200	No Content

错误码

请参见错误码。

父主题： 训练管理

上一篇：查询训练作业详情 - ShowTrainingJobDetails

下一篇：删除训练作业 - DeleteTrainingJob