文档中心>云应用>API 文档>License 相关接口>从应用软件进程验证授权信息

从应用软件进程验证授权信息

最近更新时间:2025-01-09 01:12:38

我的收藏

1. 接口描述

接口请求域名: cloudapp.tencentcloudapi.com 。

从软件进程读取 LICENSE。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:VerifyLicense。
Version String 公共参数,本接口取值:2022-05-30。
Region String 公共参数,本接口不需要传递此参数。

3. 输出参数

参数名称 类型 描述
License License 软件的详细授权信息。
示例值:见 License 数据结构。
Timestamp String 当前请求服务端的时间戳,格式为RFC3339
示例值:2025-01-08T11:38:46+08:00
Signature String 对License字段对应的json数据的签名
示例值:WdF5he2Y7UxZiDAjuPlGTS91Cr9RQYqbdJqFW6k4l5WqMErlLWQ1bRwoqdORfWadizzlhTjSpxxxxxxx
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 从软件进程读取 LICENSE

软件进程对接 LICENSE 后,通过运行时角色申请临时密钥来调用,获取对应的 LICENSE 信息。

获取到 LICENSE 后,请注意校验 LicenseStatus 是否有效,无效时软件可根据策略拒绝服务或者提供降级服务。同时,LICENSE 包含用户购买的规格信息,软件可根据规格来做运行的约束。

对接 LICENSE 的详细方案,请参考文档:

输入示例

POST / HTTP/1.1
Host: cloudapp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: VerifyLicense
<公共请求参数>

{}

输出示例

{
    "Response": {
        "License": {
            "LicenseId": "LICENSE_CLOUDAPP_A95275D8",
            "LicenseType": "Standard",
            "LicenseMode": "Subscription",
            "LicenseStatus": "Active",
            "ProviderId": 1,
            "SoftwarePackageId": "pkg-kby01bv4",
            "SoftwarePackageVersion": "1.0.0",
            "AuthorizedUserUin": "100008888888",
            "AuthorizedCloudappId": "cloudapp",
            "AuthorizedCloudappRoleId": "4000008000060000",
            "AuthorizedSpecification": [
                {
                    "ParamKey": "user_scale",
                    "ParamValue": "100",
                    "ParamKeyName": "用户规模",
                    "ParamValueName": "100人"
                }
            ],
            "BillingMode": 1,
            "LifeSpan": 1,
            "IssueDate": "2020-09-22T00:00:00+00:00",
            "ActivationDate": "2020-09-22T00:00:00+00:00",
            "ExpirationDate": "2020-09-23T00:00:00+00:00",
            "LifeSpanUnit": "D"
        },
        "Signature": "WdF5he2Y7UxZiDAjuPlGTS91Cr9RQYqbdJqFW6k4l5WqMErlLWQ1bRwoqdORfWadizzlhTjSpxxxxxxx",
        "Timestamp": "2025-01-08T12:02:40+08:00",
        "RequestId": "845c8910-b0af-499e-87cd-f7dcc93a595a"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError.DBError DBError
InternalError.FailToSign 签名失败
ResourceNotFound.LicenseNotFoundErr 找不到该License