节点接入令牌 node-enroll-tokens

生成一次性注册令牌与节点一行安装命令,并可按 id 查令牌是否已被节点用掉;令牌原文只在生成时返回一次。

点击任一接口,右侧显示对应的调用示例。

节点调度鉴权: 仅管理员2 个接口

鉴权

请求头带 X-API-Key(在「API 密钥」页开通,密钥只在开通时显示一次);也可用登录得到的 Authorization: Bearer 令牌。

X-API-Key

鉴权失败回 401;无权回 403(code 为 insufficient_scope 等)。

约定

分页参数 page(从 1 起)、page_size;排序 sort=字段 或 -字段。

时间一律 RFC 3339(UTC);金额单位为分。

写操作成功回 200/201/204;重复提交按资源唯一键回 409。

节点接入令牌对象

字段类型说明
commandstring 节点一行安装命令,只放可执行命令:含物料站地址、主控地址与信任根指纹 --trust-sha256(节点装机时从主控 7444 口取信任根包按指纹核对);令牌由 shell 内建 printf 写进 mktemp -d 建的临时目录、以 --token-file 交给装机脚本,不进任何进程的命令行参数。command_status 不是 ok 时为空串。
command_statusstring 安装命令能不能给:ok = command 是可执行命令;no_mirror = 暂时取不到节点安装包的下载地址(没配 https 物料站或取不到,或本机还没有本版本验过签的发版清单、核不了装机脚本);no_master_key = 主控密钥未初始化(重跑主控安装命令);master_addr_unknown = 认不出主控地址(在「系统管理 › 升级与维护 › 节点通信」页填节点通信公网地址 node.master_addr,或用节点能访问到的主控地址打开面板)。
可选值 ["ok","no_mirror","no_master_key","master_addr_unknown"]
expires_atstring 过期时间
idstring 令牌 id(不是凭据):用它 GET /node-enroll-tokens/{token_id} 查令牌是否已被节点用掉。
internal_master_hoststring 命令里的主控地址是本机/内网地址时为该地址(没配节点通信公网地址、取自打开面板用的地址),别的机器上的节点多半连不上它;否则不出现。
node_idinteger 用它注册出的节点 id(注册后进待初始化列表);没用过不出现。
tokenstring 一次性注册令牌原文,只在本次响应里出现。
token_in_commandboolean 命令里是否带令牌原文(true = 命令本身就是凭据,别贴进工单或日志);command_status 不是 ok 时为 false。
usedboolean 是否已有节点用它注册(一次性,用过即作废)。
used_atstring 节点用它注册的时刻;没用过不出现。

返回与错误

成功直接回资源 JSON(HTTP 2xx);失败回 application/problem+json(code、detail,校验失败带 errors);列表为 items + total。

成功
{
  "id": 1,
  "name": "example"
}
列表
{
  "items": [
    {
      "id": 1
    }
  ],
  "page": 1,
  "page_size": 20,
  "total": 1
}
失败
{
  "code": "validation_failed",
  "detail": "请求参数不合法",
  "errors": [
    {
      "code": "required",
      "field": "/name",
      "message": "name 必填"
    }
  ],
  "request_id": "0123456789abcdef",
  "status": 422,
  "title": "Unprocessable Entity",
  "type": "about:blank"
}
开始使用

体验在线演示

访问在线演示,或联系我们获取报价与安装命令