批量查询软件许可证信息
更新时间 2025-09-29 17:49:35
最近更新时间: 2025-09-29 17:49:35
本节主要介绍如何使用API批量查询软件许可证信息。
批量查询软件许可证信息，信息包括软件许可证的record信息以及usage信息：
record信息：购买记录的信息。
usage信息：软件许可证在不同时间段内的对应的容量和状态信息。
请求语法
GET /rest/v1/system/license?filter=filter&range=i-j&show=show HTTP/1.1
Date: date
Content-Type: application/json; charset=utf-8
Content-Length: length
Host: ip:port
Authorization:authorization请求参数
| 名称 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| filter | String | 设置查询的过滤条件。支持的查询类型包括：
| 否 |
| range | String | 查询范围，格式：i-j，其中i,j是正整数，i小于j，j-i<1000。按照license的购买时间由新到旧降序排列，返回第i个到第j个软件许可证。 如果输入的查询范围超过软件许可证的总个数，那么返回空结果集。 如果不输入range参数，那么返回所有软件许可证。 | 否 |
| show | String | 查询的输出结果，支持的输出结果包括record, usage。 如果不填写，就是默认两个信息都输出。 | 否 |
响应结果
| 名称 | 类型 | 描述 |
|---|---|---|
| licenseId | String | 软件许可证ID。 |
| account | String | 软件许可证所属的账号。 |
| customerName | String | 客户名称。 说明 如果申请许可证时未填写，不显示此字段。 |
| type | String | 软件许可证的购买类型：
|
| status | String | 软件许可证的状态：
如果软件许可证是Perpetual类型的，不存在过期状态。 |
| maximumLocalCapacity | Long | 当前时间允许的最大本地卷容量，单位TiB。如果不限容量，不返回此项。 |
| records | Array of record | 软件许可证购买记录的集合，详见“表1 响应参数record说明”。 |
| usages | Array of usage | 软件许可证的使用记录的集合，详见“表2 响应参数usage说明”。 |
表1 响应参数record说明
| 名称 | 类型 | 描述 |
|---|---|---|
| purchaseTime | Long | 记录购买的时间，unix时间戳（UTC），精确到毫秒。 |
| operationtype | String | 软件许可证的操作记录：
|
| localCapacity | Long | 本次购买对应的本地卷容量，单位TiB。如果不限容量，不返回此项。 |
| subscribeEffectiveTime | Long | 对于订阅模式的软件许可证，本次购买操作对应的软件许可证生效时间，unix时间戳（UTC），精确到毫秒。 |
| subscribeExpireTime | Long | 对于订阅模式的软件许可证，本次购买操作对应的软件许可证的过期时间，unix时间戳（UTC），精确到毫秒。 |
| maintenanceEffectiveTime | Long | 对于永久许可模式的软件许可证，本次购买操作对应的维保生效时间，unix时间戳（UTC），精确到毫秒。 |
| maintenanceExpireTime | Long | 对于永久许可模式的软件许可证，本次购买操作对应的维保的过期时间，unix时间戳（UTC），精确到毫秒。 |
| substatus | String | 本次购买操作的当前生效状态：
|
表2 响应参数usage说明
| 名称 | 类型 | 描述 |
|---|---|---|
| maximumLocalCapacity | Long | 对应时间段内允许的最大本地卷容量，单位TiB。如果不限容量，不返回此项。 |
| subscribeEffectiveTime | Long | 对于订阅模式的软件许可证，许可证对应的生效时间，unix时间戳（UTC），精确到毫秒。 |
| subscribeExpireTime | Long | 对于订阅模式的软件许可证，许可证对应的过期时间，unix时间戳（UTC），精确到毫秒。 |
| maintenanceEffectiveTime | Long | 对于永久许可模式的软件许可证，许可证对应的维保生效时间，unix时间戳（UTC），精确到毫秒。 |
| maintenanceExpireTime | Long | 对于永久许可模式的软件许可证，许可证对应的维保过期时间，unix时间戳（UTC），精确到毫秒。 |
| substatus | String | 对于订阅模式的软件许可证，表示对应时间段内许可证的状态；对于永久许可模式的软件许可证，表示对应时间段内许可证的维保状态：
|
请求示例
批量查询软件许可证信息。
GET /rest/v1/system/license?filter=type:Subscription HTTP/1.1
Date: Tue, 05 Aug 2025 03:09:08 GMT
Authorization: HBlock userName:signature
Host: 192.168.0.65:1443 响应示例
HTTP/1.1 200 OK
x-hblock-request-id: 649a886c536148418d05e717aa30769b
Connection: keep-alive
Content-Length: 700
Date: Tue, 05 Aug 2025 03:09:08 GMT
Content-Type: application/json;charset=utf-8
Server: HBlock
{
"data": {
"licenses": [
{
"licenseId": "ehc2b6a9-f3fb-4098-a6b3-3652a5d76269",
"account": "test@ctyun.cn",
"customerName": "Customer ABC",
"status": "Invalid",
"type": "Subscription",
"maximumLocalCapacity": 2048,
"records": [
{
"purchaseTime": 1647505314201,
"operationtype": "New",
"localCapacity": 2048,
"subscribeEffectiveTime": 1647505314201,
"subscribeExpireTime": 1655281314201,
"substatus": "Effective"
},
{
"purchaseTime": 1650097314201,
"operationtype": "Renew",
"localCapacity": 2048,
"subscribeEffectiveTime": 1655281314201,
"subscribeExpireTime": 1663057314201,
"substatus": "NotStart"
}
],
"usages": [
{
"maximumLocalCapacity": 2048,
"subscribeEffectiveTime": 1647505314201,
"subscribeExpireTime": 1663057314201,
"substatus": "Effective"
}
]
}
]
}
}
