tiup cluster license

TiUP License 是 TiUP 集群管理组件的一个重要模块，主要用于用户对平凯数据库及相关 License 进行统一管理和维护。通过 TiUP License，用户可以对许可证信息进行验证、查看、添加、删除等功能，并包含多种输出格式与操作选项，本文主要介绍 TiUP License 的具体使用。

语法

tiup cluster license [command] [flags]

[command]代表命令名字，支持的命令列表如下：

  • minfo：生成用于许可证验证的机器信息
  • add：添加一个新的 license
  • remove：移除一个没有使用的 license
  • list：列举所有的 licenses
  • display：展示一个 license 的所有信息
  • activate：激活指定 cluster 对应的产品授权

tiup cluster license minfo

命令 tiup cluster license minfo 用于生成当前机器的硬件码，硬件码是申请 TiDB 敏捷模式许可证时的绑定依据。

语法

 tiup cluster minfo [flags]

选项

  • -o, --output （string，默认会生成名字类似 "minfo-20250625T142032.txt" 的文件）

生成的机器码文件保存路径。

  • -t, --type （string，默认为" file "）

输出类型，支持：file（文件），qrcode（二维码），hash（哈希值）。

  • -h, --help

输出帮助信息。

tiup cluster license add

命令 tiup cluster license add 用于添加一个新的 license。可以通过指定 license 文件的路径，或者直接通过文本内容来添加许可证。

语法

tiup cluster license add [flags]

选项

  • -f, --file（string）

指定 license 文件的路径。

  • -t,--text（string）

直接传进 license 的文本内容。

  • -h, --help

输出帮助信息。

tiup cluster license remove

命令 tiup cluster license remove 用于删除一个未被使用的 license。通过指定许可证序列号（license-serial-number），可以将对应的许可证从 TiUP 的管理系统中移除。

语法

tiup cluster license remove <license-serial-number> [flags]
  • <license-serial-number> license 的序列号。

选项

  • -h, --help

输出帮助信息。

tiup cluster license list

命令 tiup cluster license list 用于列举出目前 TiUP 中已经添加的所有的 license，包含以下信息：激活的 TiDB 敏捷模式实例数量、已授权 license 的总实例配额、license 序列号、license 的通用名称、使用的产品系列、license 到期时间、license 是否有效、license 支持的实例配额数量。

语法

tiup cluster license list [flags]

选项

  • -h, --help

输出帮助信息。

示例

[root@host-306 tiup]# ./bin/tiup-cluster license list
Activated TiDB fusion instance count: 0
Total instance quota of Licenses authorized: 8
No TiDB fusion cluster activated

SerialNumber                 CommonName            ProductSeries  ExpiresAt   Validity  Quota
------------                 ----------            -------------  ---------   --------  -----
3KulItSstb8l6wQtb9i2aAvl5VT  Target Cert Example4  TiDBX          2025-09-10  Valid     5
9Ioa0GNHPruL7zZo1Jy7QRHMrcs  Target Cert Example3  TEM            2025-09-10  Valid     4
9KEIdYjRlEuCWwph3zxSIpxetVK  Target Cert Example2  TiDBX          2025-09-10  Valid     3
bn1hLMJ76394537jj1vAYQrFxrz  Target Cert Example1  TEM            2025-09-10  Valid     2
SerialNumberCommonNameProductSeriesExpiresAtValidityQuota
license 序列号License 通用名称使用的产品系列license 到期时间license 是否有效license 支持的实例配额数量
字段含义
SerialNumber许可证序列号，用于唯一标识这份 License，例如：3KulItSstb8l6wQtb9i2aAvl5VT。
CommonName证书名称，这里是 License 的名称或描述，例如：Target Cert Example4。
ProductSeries产品系列，示例中 TiDBX表示该 License 专用于 TiDB 敏捷模式产品系列。
ExpiresAtLicense 到期时间，示例中 2025-09-10 表示 License 的到期时间，超出这个时间 License 将失效。
ValidityLicense 当前状态，可能存在以下状态：
  • Valid：表示 License 有效
  • Invalid：表示 License 文件损坏或 License 授权机器码不匹配
  • Expired：表示 License 过期
QuotaLicense 支持的实例配额数量。这里是 5 ，表示这张 License 授权了 5 个实例的部署。

tiup cluster license display

命令 tiup cluster license display 用于显示指定 license 的详细信息。

语法

tiup cluster license display <cluster-serial-number> [flags]
  • <cluster-serial-number> license 的序列号。

选项

  • -h, --help

输出帮助信息。

示例

[root@host-306 tiup]# ./bin/tiup-cluster license display 3KulItSstb8l6wQtb9i2aAvl5VT
SerialNumber: 3KulItSstb8l6wQtb9i2aAvl5VT
CommonName: Target Cert Example4
ProductSeries: TiDBX
Validity: Valid
ValidityPeriod: 2025-03-05 00:00:00 ~ 2025-09-10 00:00:00
OrganizationNames:
        - Pingkai Xingchen (Beijing) Technology Co., Ltd.
Emails:
        - example@example.com
Fingerprints:
        - 01bae2be77d078b91805604d6645f07cecc8c72a40438890f45c73def6153ff6
Payload:
        - tidbx.instance: 5
字段含义
SerialNumber许可证序列号，用于唯一标识这份 License，例如：3KulItSstb8l6wQtb9i2aAvl5VT。
CommonNameLicense 的名称或描述。
ProductSeries产品系列，示例中 TiDBX表示该 License 专用于 TiDB 敏捷模式产品系列。
ValidityLicense 当前状态，包含Valid（表示 License 有效）、Invalid（表示 License 签名失败或者文件损坏，License 无效）、Expired（表示 License 过期）。这里是 Valid，说明该 License 目前处于有效状态。
ValidityPeriodLicense 有效期，示例中 2025-03-05 00:00:00 ~ 2025-09-10 00:00:00表示 License 的生效时间和过期时间，超出这个范围 License 将失效。
OrganizationNamesLicense 的归属机构或公司名称。
Emails联系邮箱或登记邮箱。
FingerprintsLicense 绑定的机器码。
PayloadLicense 的有效载荷，这里表示该 License 授权了 5 个 TiDBX 实例

tiup cluster license activate

命令tiup cluster license activate用于激活指定的 TiDB Fusion 集群，将 license 绑定到指定的TiDB 敏捷模式集群之上，使得集群在部署、运维时处于合法授权的状态。

语法

tiup cluster license activate <cluster-name> [flags]
  • <cluster-name>是要激活的 TiDB 敏捷模式集群名称，这是在部署集群时指定的名字，TiUP会用这个名字去查找本地或远程管理的集群。

选项

  • -h, --help

输出帮助信息。