批量查詢軟件許可證信息
更新時間 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@daliqc.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"
}
]
}
]
}
}
