Alaya NeW Cloud

查询 Pod 容器组环境变量

查询分布式训练任务中指定 Pod 内各容器实际注入的环境变量,用于核对训练进程运行时拿到的配置(如可见 GPU、分布式通信地址等)是否与创建时的设置一致。Pod 名称可从任务详情获取。

GEThttps://api.alayanew.com/v1/training/instance/{id}/{podName}/containerGroup/env

鉴权(Authorizations)

AuthorizationString必填

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

Path Parameters

idString必填

训练任务 ID(来自任务列表id)。例如:ca78d6b9-e196-5a0f-b1be-ab036b3cb91a

podNameString必填

Pod 名称。多机多卡任务下每个节点对应一个 Pod,名称可从任务详情获取。例如:worker-0

Response

statusInteger

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

messageString

接口响应信息,成功或失败原因描述。例如:"OK"

dataObject

容器环境变量响应,包含该 Pod 下所有容器及其环境变量。

显示 properties
containersArray

该 Pod 内的容器列表,每个元素对应一个容器及其环境变量集合。

显示 properties
containerNameString

容器名称。例如:"pytorch"

envsArray

该容器内的环境变量列表,每个元素为一个键值对。

显示 properties
nameString

环境变量名。例如:"CUDA_VISIBLE_DEVICES"

valueString

环境变量值。例如:"0,1,2,3"

curl -X 'GET' \
  'https://api.alayanew.com/v1/training/instance/ca78d6b9-e196-5a0f-b1be-ab036b3cb91a/worker-0/containerGroup/env' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer [YOUR_API_KEY]'
import requests

task_id = "ca78d6b9-e196-5a0f-b1be-ab036b3cb91a"
pod_name = "worker-0"
url = f"https://api.alayanew.com/v1/training/instance/{task_id}/{pod_name}/containerGroup/env"
headers = {
    "accept": "application/json",
    "Authorization": "Bearer [YOUR_API_KEY]"
}

response = requests.get(url, headers=headers)
print(response.json())
const taskId = 'ca78d6b9-e196-5a0f-b1be-ab036b3cb91a';
const podName = 'worker-0';

fetch(`https://api.alayanew.com/v1/training/instance/${taskId}/${podName}/containerGroup/env`, {
  method: 'GET',
  headers: {
    'accept': 'application/json',
    'Authorization': 'Bearer [YOUR_API_KEY]'
  }
})
  .then(res => res.json())
  .then(console.log)
  .catch(console.error);
{
  "status": 200,
  "message": "OK",
  "data": {
    "containers": [
      {
        "containerName": "pytorch",
        "envs": [
          {
            "name": "CUDA_VISIBLE_DEVICES",
            "value": "0,1,2,3"
          }
        ]
      }
    ]
  }
}
{
  "status": 403,
  "message": "Forbidden",
  "data": {}
}
{
  "status": 500,
  "message": "Internal Server Error",
  "data": {}
}

Last updated on