更新训练作业描述 - ChangeTrainingJobDescription
功能介绍
更新训练作业描述接口用于修改已存在的训练作业的描述信息。
该接口适用于以下场景：当用户需要更新训练作业的描述信息时，可以通过此接口进行修改。使用该接口的前提条件是训练作业已存在且用户具有相应的权限。更新操作完成后，训练作业的描述信息将被更新。若训练作业不存在或用户无权限操作，接口将返回相应的错误信息。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。获取该接口关联的CLI示例： hcloud ModelArts ChangeTrainingJobDescription。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
modelarts:trainJob:update
Write
trainJob *
g:ResourceTag/<tag-key>
-
-
-
-
modelarts:poolType
-
modelarts:poolId
-
URI
PUT /v2/{project_id}/training-jobs/{training_job_id}
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
description |
否 |
String |
参数解释：对训练作业的描述。 约束限制：长度限制为[0, 256]。 取值范围：不涉及。 默认取值：默认为“NULL”。 |
响应参数
状态码：200
No Content
无
请求示例
如下以修改uuid为3faf5c03-aaa1-4cbe-879d-24b05d997347的训练作业为例。修改成功后再调用查询训练作业接口即可看到description已被修改。
PUT https://endpoint/v2/{project_id}/training-jobs/3faf5c03-aaa1-4cbe-879d-24b05d997347
{
"description" : "hahaha"
}
响应示例
状态码：200
No Content
null
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
No Content |
错误码
请参见错误码。
