文档中心
声网平台
Console 官网 社区 技术支持
简体中文
search-icon

License 使用指南

更新时间 2023/01/12 07:01:34

本文档介绍如何使用声网的账号 License 和设备 License。

前提条件

在开通并使用 License 前，确保你已完成以下操作：

使用流程

License 提供 OpenAPI 和 Console 两种使用途径，具体流程如下：

1. 申请

如需申请使用 License，联系声网销售 并提供以下信息：

名称 说明
品类 选择 License 的品类：
  • 账号 License：绑定账号
  • 设备 License：绑定设备
    		•
    企业 ID (CID) 声网分配给每个企业 (组织) 的唯一标识。
    License 类型 选择 License 的类型：
  • 测试 License
  • 正式 License
    • 声网建议你在初次使用时选用测试 License。
    库存量单位 (SKU) 设置 License 的能力集，包含以下参数：
    • 产品：
      • 实时音视频 (RTC)
      • 全链路加速 (FPA)
      • 媒体流加速 (RTSA)
    • License 能力：
      • 音频
      • 视频
      • 音视频
    • License 分钟数上限：是否限制使用时长，精确到分钟
    • License 使用时间段：是否限制使用时段，精确到分钟
    有效期 测试 License 的有效期以月为单位，最少 3 个月；正式 License 的有效期以年为单位，最少 1 年。
    License 的有效期从激活开始计算。
    申请数量 申请的 License 数量。
    启用 License 的项目 ID (App ID) 列表 App ID 为声网分配给每个项目的唯一标识，从属于 CID。你可以为指定 App ID 启用 License 功能。
    是否开启预分配功能 启用预分配后，你可以将 License 预分配给指定 App ID。如不启用预分配，则全部 App ID 共享 License 额度。
    是否设置最高同时在线人数 (PCU) 限制 启用 PCU 限制后，你可以限制 CID 或 App ID 维度上同时接入 SDK 的最大人数。

    License 申请通过后，License PID 会关联到你的 CID 下，你可以在 控制台 的 License 用量页面查看 License 的 PID 和使用情况。

    2. (可选) 预分配

    配额

    在激活并使用 License 前，声网支持你调用 配额接口 将 License 额度预分配给不同的 App ID。如果不配额，则所有 App ID 共享 License 额度，先到先得。

    例：
    CID 下关联两批 License (PID 1、PID 2) 并创建三个启用 License 功能的项目 (AppID 1、AppID 2、AppID 3)，现将 PID 1 下的两个 License 预分配给 AppID 1。如下图所示：

    此时，未配额的 License，即：PID 1 下的一个 License 和 PID 2 下的三个 License，被 AppID 1、AppID 2、AppID 3 共享；而已配额的 License，即：PID 1 下的两个 License 额度仅供 AppID 1 使用。

    查询配额

    你可以调用 查询配额接口 查看 License 的分配情况。

    3. (可选) 预授权

    在激活并使用 License 前，声网支持你为 App ID 启用预授权白名单功能。该功能开启后，仅在白名单内的 设备 ID 或账号 ID 可以激活并使用 License。如不启用预授权功能，则对激活 License 的账号和设备不做限制。如需使用该功能，联系声网销售。

    4. 激活

    完成预授权和预分配后，你可以调用 激活接口 将 License 关联到设备或账号。

    License 的有效期从激活开始计算。

    5. 申请续期

    当 License 过期或即将过期时，你可以联系声网销售 申请续期并提供以下信息：

    名称 说明
    CID 声网分配给每个企业 (组织) 的唯一标识。
    PID 为 CID 下的指定 PID 续期。
    App ID (可选) 仅指定的 App ID 享有续期额度。如不指定 App ID，则 CID 下的全部 App ID 共享续期额度。
    申请数量 续期的 License 数量。

    License 续期申请通过后，续期额度会关联到 PID 下，你可以在 控制台 的 License 购买记录页面查看 续期 PID (renewID)。

    6. 续期

    续期申请通过后，你可以调用 续期接口 对即将过期或已过期的 License 进行续期操作。

    7. 查询

    开通 License 功能后，你可以在控制台查看 License 的使用情况。具体步骤如下：

    1. 登录 控制台。

    2. 点击右上角的账号名，选择下拉菜单中的 License。

    1. 进入 License 页面后，你可以在 用量查看 和 购买记录 页签查看 License 的使用情况。

    概念区分

    PID 和续期 PID

    PID

    PID 是由 SKU、有效期、品类 (账号 License 或设备 License) 定义的 License 标识。

    无论 License 的申请数量和申请批次，只要 SKU、有效期、品类不变，申请的 License 均归属于同一个 PID。License 申请 通过后，你可以在 控制台 的 License 用量页面查看一批 License 的 PID 和使用情况。

    接下来，你可以调用 激活接口 将 PID 下的 License 额度关联给指定账号或设备。

    续期 PID

    续期 PID 是基于 PID 的续期额度标识。

    当 PID 下的 License 过期或即将过期时，你可以为该 PID 申请续期额度。License 续期申请 通过后，以续期 PID 为标识的续期额度会被关联至 PID。你可以在 控制台 的 License 购买记录页面看到 PID 和其下关联的续期 PID。

    接下来，你可以调用 续期接口 将续期 PID 的 License 额度续给过期或即将过期的 License。

    licenseValue 和 licenseKey

    licenseValue

    licenseValue 是每个 License 的标识。

    用户调用 续期接口 将续期额度关联到 License 时，传入 licenseValue 指定要续期的 License。

    查询 licenseValue 的方式有以下两种：

    1. 在 控制台 的 License 用量页面点击 导出 License 明细，在导出的 CSV 文件中查看 License 栏的 licenseValue。

    1. 成功调用 激活接口 后，会返回被激活的 licenseValue。

    licenseKey

    licenseKey 是账号 ID 或设备 ID。

    用户调用 激活接口 为某个账号或设备激活 License 时，传入 licenseKey 消耗一个 License。此外，用户可以执行预授权操作，仅在白名单中的 licenseKey 可以通过校验激活 License。