授权概览信息
最近更新时间: 2026-09-17 00:02:47
1. 接口描述
接口请求域名: cwp.api3.fincloud.tencent.cn。
授权管理-授权概览信息
默认接口请求频率限制:20次/秒。
接口更新时间:2022-12-12 15:17:14。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeLicenseGeneral |
| Version | 是 | 否 | String | 公共参数,本接口取值:2018-02-28 |
| Region | 是 | 否 | String | 公共参数,地域信息本接口不需要传递此参数。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| AutoOpenStatus | Bool | 自动升级开关状态,默认 false, true 开启, false 关闭 示例值: false |
| AutoRepurchaseRenewSwitch | Bool | 自动加购订单是否自动续费 ,true 开启, false 关闭 示例值: false |
| AutoRepurchaseSwitch | Bool | 自动加购开关, true 开启, false 关闭 示例值: false |
| AvailableFlagshipVersionLicenseCnt | Uint64 | 可用旗舰版授权数 示例值: 1 |
| AvailableLHLicenseCnt | Uint64 | 可用惠普版授权数 示例值: 0 |
| AvailableLicenseCnt | Uint64 | 可用授权数 示例值: 3 |
| AvailableProVersionLicenseCnt | Uint64 | 可用专业版授权数(包含后付费). 示例值: 2 |
| CwpVersionLicenseCnt | Uint64 | 普惠版总授权数(有效订单的授权数) 示例值: 0 |
| DestroyOrderNum | Uint64 | 已销毁订单数 示例值: 0 |
| ExpireLicenseCnt | Uint64 | 已到期授权数(不包含已删除的记录) 示例值: 0 |
| FlagshipVersionLicenseCnt | Uint64 | 旗舰版总授权数(有效订单) 示例值: 1 |
| IsOpenStatusHistory | Bool | 历史是否开通过自动升级开关 示例值: false |
| LicenseCnt | Uint64 | 总授权数 (包含隔离,过期等不可用状态) 示例值: 3 |
| NearExpiryLicenseCnt | Uint64 | 即将到期授权数 (15天内到期的) 示例值: 0 |
| NotExpiredLicenseCnt | Uint64 | 未到期授权数 示例值: 3 |
| ProVersionLicenseCnt | Uint64 | 专业版总授权数(有效订单) 示例值: 2 |
| ProtectType | String | PROVERSION_POSTPAY 专业版-后付费, PROVERSION_PREPAY 专业版-预付费, FLAGSHIP_PREPAY 旗舰版-预付费 示例值: PROVERSION_POSTPAY |
| RepurchaseRenewSwitch | Bool | 自动加购是否自动续费开关,true 开启,false 关闭 示例值: false |
| UsedLicenseCnt | Uint64 | 已使用授权数 示例值: 0 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
5. 示例
示例1 查询授权概览信息
输入示例
POST / HTTP/1.1
Host: cwp.api3.fincloud.tencent.cn
Content-Type: application/json
X-TC-Action: DescribeLicenseGeneral
<Public request parameters>
{}
输出示例
{
"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
}
}