ClearML REST API 参考
API 参考页面主要分为两个部分
ClearML Rest 对象
请参阅Rest API 对象定义参考页面，查看 API 请求中使用的对象的描述。
服务定义
ClearML 的 REST API 提供以下服务
- 身份验证 - 整个系统的身份验证管理、授权和管理。
- 调试 - 调试工具。
- 项目 - 支持定义包含任务、模型和数据集版本的项目。
- 队列 - 队列管理 API（参见Worker 服务）。
- Worker - 用于 worker 机器报告状态和检索要执行任务的 API。
- 事件 - 事件（例如指标、调试样本）报告和检索 API。
- 模型 - 模型管理 API。
- 任务 - 任务管理 API。
请求格式
API 请求格式如下
base_url/endpoint
其中 base_url 是在 clearml.conf 文件中配置的 api_server（例如 https://api.clear.ml），endpoint 是可用服务指定的。content-type 为 application/json。
请求需要使用标识您要使用的 workspace 的 bearer token 进行身份验证。使用基本授权方案对 GET /auth.login 进行初始请求会生成此 token，用于后续所有 API 请求。Authorization 头部包含 Basic <credentials>，其中 credentials 是使用 ClearML 凭据（访问密钥和秘密密钥）的 base64("<key>:<secret>")。
curl -u "<access_key>:<secret_key>" -X GET https://<base_url>/auth.login
此调用将返回 token。默认情况下，token 在 30 天后过期。通过指定 expiration_sec 字段（作为查询参数或 JSON payload）可以生成具有更短过期时间的 token。