版本 2.4.8 · 最新
授权 license
当前安装的授权状态与有效期;过期锁定后不能新增站点、转发、节点等。
点击任一接口,右侧显示对应的调用示例。
运维与系统鉴权: 用户1 个接口
鉴权
请求头带 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。
授权对象
| 字段 | 类型 | 说明 |
|---|---|---|
customer | string | 授权客户名称。 |
expires_at | string | 最后接受的 license 整份有效期。 |
features | LicenseFeature[] | 授权开通的功能。 |
grace_until | string | 宽限截止,过了即锁新增;收到停用通知时取与「首次收到 + 24 小时」的较早者。 |
install_id | string | 本安装标识(install 钥指纹)。 |
last_ok_at | string | 最后一次成功拉取;从没成功过则不给。 |
locked | boolean | 新增类操作(建站点、建四层转发、建 IP 站点、建节点、节点注册令牌与审核)是否被锁。 |
readonly_days | integer | 只读缓冲天数(服务商下发,没下发按 7):防护类付费项过 not_after 后第 1 至该天 waf_enhanced 只读、xdp 与 l2 冻结,之后降级、配置保留,续费即恢复。 |
reason | string | 最近一次拉取失败的原因(协议错误码、http_<状态码>:<码>、unreachable…、clock_behind);成功为空。收到停用通知(缓冲内或 denied)时为停用原因。 |
status | string | pending 从没拉取成功(首次宽限内);active 最近拉取成功;grace 最近拉取失败(含收到停用通知后的 24 小时缓冲)、仍在宽限内;locked 宽限已过;denied 超管已停用本安装且已过 24 小时缓冲,超管撤回后下一次拉取即恢复。 |
stop_at | string | 试用停服时刻(套餐到期 + 7 天);只在 trial 为 true 时给。 |
trial | boolean | 最后接受的授权是否试用授权(服务商不下发 = 非试用)。试用不发 7/3/1 天到期提醒,到 stop_at 全部节点停止服务、配置保留,购买正式授权或延后 stop_at 后约 1 分钟内自动恢复。 |
trial_stopped | boolean | 此刻是否已到试用停服(按主控记录的最晚时间判,往回拨本机时钟不会提前恢复);非试用为 false。 |
返回与错误
成功直接回资源 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"
}