批量查询软件许可证信息,信息包括软件许可证的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 设置查询的过滤条件。支持的查询类型包括:
licenseId:软件许可证ID。
status:软件许可证的状态:
Effective:已生效。
Expired:已过期。
Invalid:无效。
type:软件许可证的购买类型:
Subscription:订阅模式。
Perpetual:永久许可模式。
否 range 查询范围,格式:i-j,其中i,j是正整数,i小于j,j-i<1000。按照license的购买时间由新到旧降序排列,返回第i个到第j个软件许可证。
如果输入的查询范围超过软件许可证的总个数,那么返回空结果集。
如果不输入range参数,那么返回所有软件许可证。
否 show 查询的输出结果,支持的输出结果包括record, usage。
如果不填写,就是默认两个信息都输出。
否
响应结果
名称 描述 licenseId 软件许可证ID。 account 软件许可证所属的账号。 type 软件许可证的购买类型:
Subscription:订阅模式。
Perpetual:永久许可模式。
status 软件许可证的状态:
Effective:已生效。
Expired:已过期。
Invalid:已失效。
如果软件许可证是Perpetual类型的,不存在过期状态。
maximumLocalCapacity 当前时间允许的最大本地卷容量,单位TiB。如果不限容量,不返回此项。 records 软件许可证购买记录的集合,包含:purchaseTime、operationtype、localCapacity、subscribeEffectiveTime、subscribeExpireTime、maintenanceEffectiveTime、maintenanceExpireTime、substatus。
类型:数组
purchaseTime 记录购买的时间,unix时间戳(UTC),精确到毫秒。 operationtype 软件许可证的操作记录:
New:首次购买。
Expand:扩容。
Renew:续订/续保。
localCapacity 本次购买对应的本地卷容量,单位TiB。如果不限容量,不返回此项。 subscribeEffectiveTime 对于订阅模式的软件许可证,本次购买操作对应的软件许可证生效时间,unix时间戳(UTC),精确到毫秒。 subscribeExpireTime 对于订阅模式的软件许可证,本次购买操作对应的软件许可证的过期时间,unix时间戳(UTC),精确到毫秒。 maintenanceEffectiveTime 对于永久许可模式的软件许可证,本次购买操作对应的维保生效时间,unix时间戳(UTC),精确到毫秒。 maintenanceExpireTime 对于永久许可模式的软件许可证,本次购买操作对应的维保的过期时间,unix时间戳(UTC),精确到毫秒。 substatus 本次购买操作的当前生效状态:
NotStart:未生效。
Effective:已生效。
Expired:已过期。
usages 软件许可证的使用记录的集合,包含:maximumLocalCapacity、subscribeEffectiveTime、subscribeExpireTime、maintenanceEffectiveTime、maintenanceExpireTime、substatus。
类型:数组
maximumLocalCapacity 对应时间段内允许的最大本地卷容量,单位TiB。如果不限容量,不返回此项。 subscribeEffectiveTime 对于订阅模式的软件许可证,许可证对应的生效时间,unix时间戳(UTC),精确到毫秒。 subscribeExpireTime 对于订阅模式的软件许可证,许可证对应的过期时间,unix时间戳(UTC),精确到毫秒。 maintenanceEffectiveTime 对于永久许可模式的软件许可证,许可证对应的维保生效时间,unix时间戳(UTC),精确到毫秒。 maintenanceExpireTime 对于永久许可模式的软件许可证,许可证对应的维保过期时间,unix时间戳(UTC),精确到毫秒。 substatus 对于订阅模式的软件许可证,表示对应时间段内许可证的状态;对于永久许可模式的软件许可证,表示对应时间段内许可证的维保状态:
NotStart:未生效。
Effective:已生效。
Expired:已过期。
请求示例
批量查询软件许可证信息。
GET /rest/v1/system/license?filter=type:Subscription HTTP/1.1
Date: Thu, 17 Mar 2022 09: 40: 42 GMT
Authorization: HBlock userName:signature
Host: 192.168.0.121: 1443
响应示例
HTTP/1.1 200 OK
x-hblock-request-id: 453c0e4d909b4cb4801759b89f490bbc
Connection: keep-alive
Content-Length: 671
Date: Thu,
17 Mar 2022 09: 40: 42 GMT
Content-Type: application/json;charset=utf-8
Server: HBlock
{
"data": {
"licenses": [
{
"licenseId": "ehc2b6a9-f3fb-4098-a6b3-3652a5d76269",
"account": "xxx@testcom.cn",
"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"
}
]
}
]
}
}