Alaya NeW Cloud

获取训练任务模版

根据模版 ID 查询单个训练任务模版的完整配置,包含资源规格、存储挂载、环境变量、启动命令等。模版 ID 可从训练任务模版列表获取。

GEThttps://api.alayanew.com/v1/training/template/{id}

鉴权(Authorizations)

AuthorizationString必填

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

Path Parameters

idString必填

训练任务模版 ID(来自模版列表id)。例如:tpl_6f1a62c0a5bf4e0c9b2f

Response

statusInteger

业务状态码,200 表示成功。

messageString

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

dataObject

训练任务模版详情。

显示 properties
idString

模版 ID。例如:"tpl_6f1a62c0a5bf4e0c9b2f"

nameString

模版名称。例如:"pytorch-2gpu-template"

descString

任务描述。例如:"常用2卡训练模板"

trainingTypeString

训练类型:PRE_TRAINING 预训练、HPC 高性能计算。例如:"PRE_TRAINING"

trainingFramworkString

训练框架:PyTorchDeepSpeedMPITensorFlow。例如:"TensorFlow"

aidcIdInteger

智算中心 ID。例如:2

envObject

环境变量(原始 JSON)。例如:[{"key": "ENV", "value": "production"}]

resourceObject

资源规格(原始 JSON)。例如:{"type":"worker","gpuName":"NVIDIA-L40S-PCIE-48G","cpuCores":"1","gpuCount":"1","memoryGB":"2","productCode":"PRD-QTT","productName":"量子训练","workerCount":1,"productPrice":"0.0002B"}

storageConfigsArray<Object>

存储配置参数。

显示 properties
idString

存储实例 ID。例如:"00964ce3-b99c-43da-8826-ab9c5574eef2"

nameString

存储名称。例如:"nas0001"

descriptionString

存储描述。例如:"训练数据"

orderInstanceIdString

订阅实例ID。例如:"00964ce3-b99c-43da-8826-ab9c5574eef2"

statusString

状态。例如:"Creating"

storageTypeString

存储类型。例如:"capacity"

quotaString

配额(GB)。例如:"500"

usedString

已使用量(GB)。例如:"10"

mountPathString

默认挂载路径。例如:"/mnt/nas/new_path"

resourceObject

资源。

显示 properties
quotaString

系统盘容量(GB)。例如:50

productNameString

产品名(资源类型)。例如:"NA型实-大容量存储"

productCodeString

产品编码。例如:"PRD-NAS-CAPACITY-1"

createTimeString

创建时间。例如:"2025-12-10 00:00:00"

lastUpdateTimeString

修改时间。例如:"2025-12-10 00:00:00"

releaseTimeString

释放时间。例如:"2023-12-10 23:59:59"

tenantIdString

租户ID。例如:"4d7119bd-8e71-49a9-a319-f84d165f79d9"

priceString

价格。例如:"0.01B"

priceUnitString

价格单位,例如:元/GB/月。例如:8

currencyUnitOfMeasureInteger

现金单位。例如:9

currencyUnitPriceFormulaString

现金价格公式,例如:元/GB/月。例如:"0.01B"

sharePolicyObject

分享策略。

显示 properties
policyString

策略。例如:"R"

createdByString

创建者Id。例如:"4d7119bd-8e71-49a9-a319-f84d165f79d9"

createdByNameString

创建者名称。

lastUpdateByString

上次更新者ID。

lastUpdateByNameString

上次更新者名称。

createSceneString

创建来源实例类型,如 ALab、CCI,为空表示手动创建。例如:"ALab"

createSceneInstanceIdString

创建来源实例ID。例如:"00964ce3-b99c-43da-8826-ab9c5574eef2"

isDefaultStorageBoolean

是否为当前实例的默认存储(创建时绑定的存储)。例如:true

aidcIdInteger

智算中心ID。例如:[{"storageId":"0000-0000-0000-0000","storageType":"nas-capacity","fileDirectory":"nas123","mountPath":"/root/nas/123","onlyRead":true}]

startCommandString

容器启动命令。例如:"bash /workspace/main-train.sh"

framworkString

框架(与库字段 framework 保持一致)。例如:"PYTORCH"

enableAutoRetryBoolean

是否支持自动重试。例如:true

maxRetryCountInteger

最大重试次数。例如:3

enableTimeoutCancelBoolean

是否超时取消。例如:true

timeoutHoursInteger

任务运行最长时长(小时)。例如:24

imageTypeString

镜像类型,应用镜像: application|基础镜像:general|私有镜像:private。例如:"general"

imageString

镜像。例如:"registry.example.com/pytorch:2.1.0"

createdTimeString

创建时间。例如:"2020-20-10 20:00:00"

createdByString

创建者 ID。例如:"1"

lastUpdateTimeString

最近更新时间。例如:"2020-20-10 20:00:00"

lastUpdateByString

更新者。例如:"user01"

priorityInteger

任务优先级,1~3,数值越小优先级越高。例如:3

curl -X 'GET' \
  'https://api.alayanew.com/v1/training/template/tpl_6f1a62c0a5bf4e0c9b2f' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer [YOUR_API_KEY]'
import requests

template_id = "tpl_6f1a62c0a5bf4e0c9b2f"
url = f"https://api.alayanew.com/v1/training/template/{template_id}"
headers = {
    "accept": "application/json",
    "Authorization": "Bearer [YOUR_API_KEY]"
}

response = requests.get(url, headers=headers)
response.raise_for_status()
print(response.json())
const templateId = 'tpl_6f1a62c0a5bf4e0c9b2f';

fetch(`https://api.alayanew.com/v1/training/template/${templateId}`, {
  method: 'GET',
  headers: {
    'accept': 'application/json',
    'Authorization': 'Bearer [YOUR_API_KEY]'
  }
})
  .then(res => {
    if (!res.ok) {
      throw new Error(`HTTP error! status: ${res.status}`);
    }
    return res.json();
  })
  .then(console.log)
  .catch(console.error);
{
  "status": 200,
  "message": "OK",
  "data": {
    "id": "tpl_6f1a62c0a5bf4e0c9b2f",
    "name": "pytorch-2gpu-template",
    "desc": "常用2卡训练模板",
    "trainingType": "PRE_TRAINING",
    "trainingFramwork": "TensorFlow",
    "aidcId": 2,
    "env": [
      {
        "key": "ENV",
        "value": "production"
      }
    ],
    "resource": {
      "type": "worker",
      "gpuName": "NVIDIA-L40S-PCIE-48G",
      "cpuCores": "1",
      "gpuCount": "1",
      "memoryGB": "2",
      "productCode": "PRD-QTT",
      "productName": "量子训练",
      "workerCount": 1,
      "productPrice": "0.0002B"
    },
    "storageConfigs": [
      {
        "storageId": "0000-0000-0000-0000",
        "storageType": "nas-capacity",
        "fileDirectory": "nas123",
        "mountPath": "/root/nas/123",
        "onlyRead": true
      }
    ],
    "startCommand": "bash /workspace/main-train.sh",
    "framwork": "PYTORCH",
    "enableAutoRetry": true,
    "maxRetryCount": 3,
    "enableTimeoutCancel": true,
    "timeoutHours": 24,
    "imageType": "general",
    "image": "registry.example.com/pytorch:2.1.0",
    "createdTime": "2020-20-10 20:00:00",
    "createdBy": "1",
    "lastUpdateTime": "2020-20-10 20:00:00",
    "lastUpdateBy": "user01",
    "priority": 3
  }
}
{
  "status": 403,
  "message": "Forbidden",
  "data": {}
}
{
  "status": 500,
  "message": "Internal Server Error",
  "data": {}
}

Last updated on