Getting information about a specific license

REST API Reference Guide for Virtual Storage Platform 5000, Virtual Storage Platform E Series, and Virtual Storage Platform G/F Series

Version

93-07-0x

90-09-0x

88-08-10

Audience

anonymous

Part Number

MK-98RD9014-17

The following request obtains license information by specifying a software license ID.

For a list of storage systems that support this API, see Overview of the initial settings of a storage system.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/licenses/object-ID

Request message

Object ID

Specify the licenseId value obtained by getting information about the licenses.

Attribute	Type	Description
licenseId	int	(Required) License ID

Query parameters: None.

Body: None.

Response message

Body

{
  "licenseId": 32775,
  "programProductName": "Dynamic Provisioning",
  "status": "Installed",
  "keyType": "Permanent",
  "capacityLimitStatus": "Unlimited",
  "usedCapacityInGB": 24379
}

The following table lists the license information that you can obtain. For details about license information, see the System Administrator Guide.

Attribute	Type	Description
licenseId	int	License ID
programProductName	string	Software name
status	string	Installation status of the software `Installed`: Installed `Installed (Disabled)`: Installed (License is disabled) `Not Installed`: Not installed `Not Enough License`: Installed (Not enough license capacity) `Grace Period`: Not enough license capacity because of additional LDEVs or pool volumes, or creation of pairs `Expired`: Expired Output when the `keyType` attribute is `Temporary`.
keyType	string	License key type `Permanent`: For purchase (no limit on effective term) `Term`: For purchase (effective term specified) `Temporary`: For trial use before purchase `Emergency`: For emergency use
capacityLimitStatus	string	Specified if the permitted license capacity has a limit `Limited`: Limited `Unlimited`: Unlimited
permittedCapacityInTB	long	Permitted license capacity (TB)
usedCapacityInGB	long	Volume capacity used by the software (GB)
remainingDays	int	Remaining days before expiration If the `keyType` attribute is `Term`, `Temporary`, or `Emergency`: Remaining days before expiration If a license for which the `keyType` attribute is `Temporary` is expired: Remaining days after the expiration date until re-installation of the software becomes available

Status codes

For details on the status codes of the request for this operation, see the description on HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/licenses/34055