1. 接口描述

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

DescribeLicense

客户根据请求的参数获取当前名下的许可证信息

{
  "Filters": [
    {
      "Name": "QueryType",
      "Values": ["IncludeAddition"]
    }
  ]
}

返回的内容结构如下：

Response.RequestId 为当前请求的唯一 id
Response.Token 为 license 信息 jwt 加密后的 token 串

{
  "Response": {
    "RequestId": "cd15813b-adff-460e-b9fc-64579e96412d",
    "Token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjkzMjQ4MTc5ODAsImlhdCI6MTc1NjE3Nzk4MCwiaXNzIjoibGljZW5zZS1zZXJ2aWNlIiwicGF5bG9hZCI6eyJNYWluTGljZW5zZSI6eyJMaWNlbnNlTW9kZSI6IlN1YnNjcmlwdGlvbiIsIkJpbGxpbmdNb2RlIjoxLCJDcmVhdGVTb3VyY2UiOiJTTjE3MTk0MDc1NDc0SEJETSIsIkF1dGhvcml6ZWRDbG91ZGFwcFJvbGVJZCI6IjcwMDAwMTgzMzgwNiIsIkF1dGhvcml6ZWRDbG91ZGFwcElkIjoiY2xvdWRhcHAtc2V3ZWM2cHMiLCJBdXRob3JpemVkVXNlclVpbiI6IjcwMDAwMDkxODE1NiIsIkxpZmVTcGFuVW5pdCI6IlkiLCJMaWZlU3BhbiI6MzY1LCJTb2Z0d2FyZVBhY2thZ2VJZCI6InBrZy0xZ2xlaG9tNyIsIlNvZnR3YXJlUGFja2FnZVZlcnNpb24iOiIwLjAuMSIsIkF1dGhvcml6ZWRTcGVjaWZpY2F0aW9uIjpbeyJQYXJhbUtleSI6InZlcnNpb24iLCJQYXJhbUtleU5hbWUiOiLniYjmnKwiLCJQYXJhbVZhbHVlIjoiYmFzaWMiLCJQYXJhbVZhbHVlTmFtZSI6IuWfuuehgOeJiCJ9LHsiUGFyYW1LZXkiOiJzaXplIiwiUGFyYW1LZXlOYW1lIjoi6KeE5qC8IiwiUGFyYW1WYWx1ZSI6IjEwMCIsIlBhcmFtVmFsdWVOYW1lIjoiMTAw5Lq66KeE5qihIn1dLCJQcm92aWRlcklkIjoxMDAwMDAwNzEsIlByb3ZpZGVyVWluIjoiNzAwMDAwOTE4MTU2IiwiSXNzdWVEYXRlIjoiMjAyNC0wNi0yNlQyMToxMjozMiswODowMCIsIkFjdGl2YXRpb25EYXRlIjoiMjAyNC0wNi0yNlQyMToxMjozNSswODowMCIsIkV4cGlyYXRpb25EYXRlIjoiMjM4OS0wNi0yNlQyMToxMjozNSswODowMCIsIkxpY2Vuc2VTdGF0dXMiOiJBY3RpdmUiLCJMaWNlbnNlSWQiOiI3MDAwMDA5MTgxNTY6cGtnLTFnbGVob203OmNsb3VkYXBwLXNld2VjNnBzOjgwMDciLCJMaWNlbnNlVHlwZSI6IlN0YW5kYXJkIiwiTGljZW5zZUxldmVsIjoiTWFzdGVyIn0sIkFkZGl0aW9uTGljZW5zZXMiOltdLCJUaW1lc3RhbXAiOiIyMDI1LTA4LTI2VDExOjEzOjAwKzA4OjAwIn19.G8Lx49xZBW0Rh3lRA15XzZ-PzLJj0bAxwnklx0pTjrHWxqxQdETAdGfU_QaGI_WZfYh2IVbFcwHnRLiRj6pQb4guCMpCbcsgL28BRS4g1wnaFhjcyEQLLtpDdz4_lPnOR2VHHvnfwhLZtccAgsRpeedPMBK1hwO9D3WKisQg2LcIr0V-QB8gmgIqqyqrLW6z37QpjgB4ZyJ5bIC1J-0-VmghskA04xnQRPdGJtlyBhjzVjeDxBq5JOqm3Am0Nqu1jyTd3MuYgSRwJqkDyjVBOGFGGy6mZCIYnxU_ET6-0ZEendqYwXDkpYG4rZZv5YmRCXiSESYz0zx4czwmFWkw-TjRSvUQBxBfsoDcAgyzpY7zBOTnbrr7DyoMvVnnHo7vb0if8_vkub6o0MuRnvdDYxNJtnTtlIScCadWAIvWUQ1DlUw2kzS-h9Ju2h7JhKw9cUeutu0X_6V4arZu9JlgWT9Ns7BtS9Y5JxgQOd36Aan39Rwohy_BrVwjOkbvDuTFLc_yNUlNdq5T2GNbDjABCmi73CGhCuWyPgtRs4ftpPugDRrTe4E95F224jdhf7I0He-nY4i1MoVjz8Zzm4v0vH67cMfcu0XVhs7ywvmu5tBSwm0uuhAXFFIbSrgEzuadxNhSi6qVCFNLnjiPYplK1M9mxG8Hc-fU-0A0TPepx8Q"
  }
}

验签过程：
对 Response.Token 内容使用公钥进行解码转换得到许可结构体信息，返回的内容结构如下，其中 paylod 中的信息为许可证信息结构：

{
  "exp": 9324758169,
  "iat": 1756118169,
  "iss": "license-service",
  "payload": {
    "MainLicense": {
      "LicenseMode": "Subscription",
      "BillingMode": 1,
      "CreateSource": "SN1719406931EJJ1E",
      "AuthorizedCloudappRoleId": "700001833621",
      "AuthorizedCloudappId": "cloudapp-992nqg9u",
      "AuthorizedUserUin": "700001833621",
      "LifeSpanUnit": "Y",
      "LifeSpan": 365,
      "SoftwarePackageId": "pkg-1glehom7",
      "SoftwarePackageVersion": "0.0.1",
      "AuthorizedSpecification": [
        {
          "ParamKey": "version",
          "ParamKeyName": "版本",
          "ParamValue": "basic",
          "ParamValueName": "基础版"
        },
        {
          "ParamKey": "size",
          "ParamKeyName": "规格",
          "ParamValue": "100",
          "ParamValueName": "100 人规模"
        }
      ],
      "ProviderId": 100000071,
      "ProviderUin": "700000918156",
      "IssueDate": "2024-06-26T21:02:16+08:00",
      "ActivationDate": "2024-06-26T21:02:19+08:00",
      "ExpirationDate": "2389-06-26T21:02:19+08:00",
      "LicenseStatus": "Active",
      "LicenseId": "700000918156:pkg-1glehom7:cloudapp-992nqg9u:3988",
      "LicenseType": "Standard",
      "LicenseLevel": "Master"
    },
    "AdditionLicenses": [
      {
        "LicenseMode": "Subscription",
        "BillingMode": 1,
        "CreateSource": "SN1719406931EJJ1E",
        "AuthorizedCloudappRoleId": "700001833621",
        "AuthorizedCloudappId": "cloudapp-992nqg9u",
        "AuthorizedUserUin": "700001833621",
        "LifeSpanUnit": "Y",
        "LifeSpan": 365,
        "SoftwarePackageId": "pkg-1glehom7",
        "SoftwarePackageVersion": "0.0.1",
        "AuthorizedSpecification": [
          {
            "ParamKey": "version",
            "ParamKeyName": "版本",
            "ParamValue": "basic",
            "ParamValueName": "基础版"
          },
          {
            "ParamKey": "size",
            "ParamKeyName": "规格",
            "ParamValue": "100",
            "ParamValueName": "100 人规模"
          }
        ],
        "ProviderId": 100000071,
        "ProviderUin": "700000918156",
        "IssueDate": "2024-06-26T21:02:16+08:00",
        "ActivationDate": "2024-06-26T21:02:19+08:00",
        "ExpirationDate": "2389-06-26T21:02:19+08:00",
        "LicenseStatus": "Active",
        "LicenseId": "700000918156:pkg-1glehom7:cloudapp-992nqg9u:3988",
        "LicenseType": "Standard",
        "LicenseLevel": "Master"
      }
    ],
    "Timestamp": "2025-08-25T18:36:09+08:00"
  }
}

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeLicense。
Version	是	String	公共参数，本接口取值：2022-05-30。
Region	否	String	公共参数，本接口不需要传递此参数。
Filters.N	否	Array of Filter	可选过滤器

3. 输出参数

参数名称	类型	描述
Token	String	针对上面raw的签名示例值：eyJhbGciOi
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 云应用许可校验接口

云应用准备更新 LICENCE 校验的接口

输入示例

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

{}

输出示例

{
    "Response": {
        "Token": "eyJhbGciOi",
        "RequestId": "2aab88d8-b5bd-42ea-92ee-f8df1228e278"
    }
}

示例2 云应用许可校验接口带增购信息

云应用准备更新 LICENCE 校验的接口带增购信息

输入示例

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

{
    "Filters": [
        {
            "Name": "QueryType",
            "Values": [
                "IncludeAddition"
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "Token": "eyJhbGciOi",
        "RequestId": "f3891f61-7c21-4223-9b5b-33a3e7ca3095"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

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

获取license信息

本页目录：

1. 接口描述

DescribeLicense

2. 输入参数

3. 输出参数

4. 示例

示例1 云应用许可校验接口

输入示例

输出示例

示例2 云应用许可校验接口带增购信息

输入示例

输出示例

5. 开发者资源

腾讯云 API 平台

API Inspector

SDK

命令行工具

6. 错误码

获取license信息

本页目录：

1. 接口描述

DescribeLicense

2. 输入参数

3. 输出参数

4. 示例

示例1 云应用许可校验接口

输入示例

输出示例

示例2 云应用许可校验接口 带增购信息

输入示例

输出示例

5. 开发者资源

腾讯云 API 平台

API Inspector

SDK

命令行工具

6. 错误码

示例2 云应用许可校验接口带增购信息