跳转到正文

API 与 CLI

日常创建、查看和排查任务时,请优先使用 Web 控制台。使用 API 或 CLI 自动化时,需要匹配目标环境的接口资料、接入地址、认证方式、授权范围和版本规则;开始前先从平台管理员取得这些信息。

如果需要查看接口字段和请求样例,可以查阅 RLark 项目中的 API 调用样例(简体中文)Storage API 说明(简体中文)OpenAPI 文件。这些资料对应 main 分支;接入具体环境时,必须改用与该环境相同的 Git tag 或 commit,并继续遵守本页的认证和授权要求。

在自动化前确认接入信息

编写脚本、SDK、CI 流程或外部集成前,请平台管理员明确提供:

  1. 目标环境及其精确 RLark 版本或 commit;
  2. 允许使用的 Base URL、端点、方法和资源范围;
  3. 认证方式、身份、授权范围和凭据轮换方式;
  4. API 版本的兼容、升级和弃用规则;
  5. 并发更新、resourceVersion、重试、幂等性和速率限制要求;
  6. 日志、审计、配额、故障恢复和支持方式;
  7. 写操作的影响、停止条件、恢复方案和验证方法。

这些信息不完整时,请继续使用已获授权的控制台流程,不要从浏览器开发者工具复制请求来构造写操作。

v1alpha1 可能随版本变化

RLark 资源使用 rlinf.io/v1alpha1。字段、行为和端点可能随升级变化;自动化必须与目标环境的精确版本保持一致。

区分控制台会话和 API 凭据

浏览器登录只用于进入控制台,不会签发可供自动化使用的 Bearer token。浏览器中保存的会话标记也不是 API 凭据。

一次 HTTP 请求成功,只表示请求被接口接受;它不代表调用者获得了组织授权,也不能确认后续资源协调、数据面操作或业务结果已经完成。

使用 YAML 预览核对任务

任务创建器中的 YAML 预览用于检查即将提交的 RLark Job CRD。它不是通用 YAML 导入、版本迁移或审计工具,也不会展示 RLinf/Hydra 的最终解析配置。

不要把 /admin/api 用作接口文档

管理后台的“接口参考”页面是静态展示,不包含可用于生产自动化的认证、授权和版本说明。不要从该页面复制请求。

使用命令行工具

  • rlarkadm 用于平台部署和数据平面接入,只应由获授权的管理员按照环境运行手册使用。
  • 使用 rlarkctl 前,请从平台管理员取得与目标环境匹配的二进制、安装和认证步骤、版本兼容范围及受支持命令。缺少任一项时,继续使用已获授权的控制台流程。

需要管理操作时,先阅读管理 RLark。各功能的使用条件见功能可用情况与限制。其他源码资料见文档范围与其他资料