Skip to main content

ClearML REST API 参考

API参考页面分为两个主要部分：

ClearML Rest 对象​

请参阅Rest API 对象定义参考页面，以查看API请求中使用的对象的描述。

服务定义​

ClearML的REST API提供以下服务：

  • 认证 - 整个系统的认证管理、授权和管理。
  • Debug - 调试工具。
  • 项目 - 支持定义包含任务、模型和数据集版本的项目。
  • 队列 - 队列 管理 API (参见 工人 服务).
  • Workers - 用于工作机器报告状态并检索任务以执行的API。
  • 事件 - 事件（例如指标、调试样本）报告和检索API。
  • 模型 - 模型管理API。
  • 任务 - 任务 管理 API.

请求格式​

API请求的格式如下：

base_url/endpoint

其中base_url是您在clearml.conf文件中配置的api_server（例如https://api.clear.ml），而 端点是根据可用服务指定的。内容类型为application/json。

请求需要使用承载令牌进行身份验证，该令牌标识您要使用的工作区。初始请求GET /auth.login，使用基本授权方案生成此令牌，用于所有后续的API请求。授权头包含Basic ，其中credentials是使用ClearML凭据（访问密钥和秘密密钥）的base64(":")。

curl -u "<access_key>:<secret_key>" -X GET https://<base_url>/auth.login

此调用将返回令牌。默认情况下，令牌在30天后过期。通过指定expiration_sec字段（作为查询参数或JSON有效负载），可以生成具有较短过期时间的令牌。