有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

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

授权管理-授权概览信息

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeLicenseGeneral。
Version String 公共参数,本接口取值:2018-02-28。
Region String 公共参数,此参数为可选参数。

3. 输出参数

参数名称 类型 描述
LicenseCnt Integer 总授权数 (包含隔离,过期等不可用状态)
示例值:3
AvailableLicenseCnt Integer 可用授权数
示例值:3
AvailableProVersionLicenseCnt Integer 可用专业版授权数(包含后付费).
示例值:2
AvailableFlagshipVersionLicenseCnt Integer 可用旗舰版授权数
示例值:1
NearExpiryLicenseCnt Integer 即将到期授权数 (15天内到期的)
示例值:0
ExpireLicenseCnt Integer 已到期授权数(不包含已删除的记录)
示例值:0
AutoOpenStatus Boolean 自动升级开关状态,默认 false, true 开启, false 关闭
示例值:false
ProtectType String PROVERSION_POSTPAY 专业版-后付费, PROVERSION_PREPAY 专业版-预付费, FLAGSHIP_PREPAY 旗舰版-预付费
示例值:PROVERSION_POSTPAY
IsOpenStatusHistory Boolean 历史是否开通过自动升级开关
示例值:false
UsedLicenseCnt Integer 已使用授权数
示例值:0
NotExpiredLicenseCnt Integer 未到期授权数
示例值:3
FlagshipVersionLicenseCnt Integer 旗舰版总授权数(有效订单)
示例值:1
ProVersionLicenseCnt Integer 专业版总授权数(有效订单)
示例值:2
CwpVersionLicenseCnt Integer 普惠版总授权数(有效订单的授权数)
示例值:0
AvailableLHLicenseCnt Integer 可用惠普版授权数
示例值:0
AutoRepurchaseSwitch Boolean 自动加购开关, true 开启, false 关闭
示例值:false
AutoRepurchaseRenewSwitch Boolean 自动加购订单是否自动续费 ,true 开启, false 关闭
示例值:false
DestroyOrderNum Integer 已销毁订单数
示例值:0
RepurchaseRenewSwitch Boolean 是否自动续费开关,true 开启,false 关闭
示例值:false
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询授权概览信息

输入示例

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

{}

输出示例

{
    "Response": {
        "AutoOpenStatus": true,
        "AvailableFlagshipVersionLicenseCnt": 1,
        "AvailableLHLicenseCnt": 0,
        "AvailableLicenseCnt": 3,
        "AvailableProVersionLicenseCnt": 2,
        "CwpVersionLicenseCnt": 0,
        "ExpireLicenseCnt": 0,
        "FlagshipVersionLicenseCnt": 1,
        "IsOpenStatusHistory": true,
        "LicenseCnt": 3,
        "NearExpiryLicenseCnt": 0,
        "NotExpiredLicenseCnt": 3,
        "ProVersionLicenseCnt": 2,
        "ProtectType": "FLAGSHIP_PREPAY",
        "RequestId": "d9a5456b-a2db-4106-bd12-32e2c735435d",
        "UsedLicenseCnt": 0,
        "AutoRepurchaseSwitch": false,
        "AutoRepurchaseRenewSwitch": false,
        "DestroyOrderNum": 0,
        "RepurchaseRenewSwitch": false
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。