更新训练任务描述

修改分布式训练任务的描述文本，便于团队成员理解任务用途。该接口仅更新描述字段，不影响任务的运行状态与资源配置。任务 ID 可从任务列表获取。

PUThttps://api.alayanew.com/v1/training/instance/{id}/desc

鉴权（Authorizations）

bearerAuth

AuthorizationString必填

用户可通过已获取的 Open API Key 做验证。例如：Bearer [YOUR_API_KEY]。

Path Parameters

idString必填

训练任务 ID（来自任务列表的 id）。例如：ca78d6b9-e196-5a0f-b1be-ab036b3cb91a。

Request body

application/json

descString

新的训练任务描述，将覆盖原有描述。例如：Llama3-8B 指令微调，第二轮调参。

Response

application/json · 200

statusInteger

业务状态码，200 表示更新成功。

messageString

接口响应信息。例如："OK"。

dataObject

操作结果数据，本接口无业务数据返回，通常为空对象 {}。

curl -X 'PUT' \
  'https://api.alayanew.com/v1/training/instance/ca78d6b9-e196-5a0f-b1be-ab036b3cb91a/desc' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer [YOUR_API_KEY]' \
  -d '{
  "desc": "Llama3-8B 指令微调，第二轮调参"
}'

import requests

task_id = "ca78d6b9-e196-5a0f-b1be-ab036b3cb91a"
url = f"https://api.alayanew.com/v1/training/instance/{task_id}/desc"
headers = {
    "accept": "application/json",
    "Content-Type": "application/json",
    "Authorization": "Bearer [YOUR_API_KEY]"
}
payload = {"desc": "Llama3-8B 指令微调，第二轮调参"}

response = requests.put(url, headers=headers, json=payload)
print(response.json())

const taskId = 'ca78d6b9-e196-5a0f-b1be-ab036b3cb91a';

fetch(`https://api.alayanew.com/v1/training/instance/${taskId}/desc`, {
  method: 'PUT',
  headers: {
    'accept': 'application/json',
    'Content-Type': 'application/json',
    'Authorization': 'Bearer [YOUR_API_KEY]'
  },
  body: JSON.stringify({ desc: 'Llama3-8B 指令微调，第二轮调参' })
})
  .then(res => res.json())
  .then(console.log)
  .catch(console.error);

{
  "status": 200,
  "message": "OK",
  "data": {}
}

{
  "status": 403,
  "message": "Forbidden",
  "data": {}
}

{
  "status": 500,
  "message": "Internal Server Error",
  "data": {}
}