Skip to main content
ZStack
System Global Type/License Operations

GetLicenseInfo

GetLicenseInfo

GET/zstack/v1/licenses

Operation ID

GetLicenseInfo

Since

4.1.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

Query Parameters

  • additionSession
    String

    Optional. The additional information. The value is a JSON-formatted string.

  • systemTags
    List

    Optional. The system tags.

  • userTags
    List

    Optional. The user tags.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • error
    ErrorCodeRequired

    The error code. If not null, the operation fails, or vice versa. For more information, see error.

    • code
      StringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • description
      StringRequired

      The brief description of the error.

    • details
      StringRequired

      The details about the error.

    • elaboration
      StringRequired

      The reserved field. Default value: null.

    • opaque
      LinkedHashMapRequired

      The reserved field. Default value: null.

    • cause
      ErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

  • inventory
    LicenseInventoryRequired

    See inventory.

    • licenseType
      StringRequired

      The license type.

    • licenseRequest
      StringRequired

      The license request.

    • expiredDate
      StringRequired

      The expired date.

    • issuedDate
      StringRequired

      The issued date.

    • user
      StringRequired

      The user.

    • prodInfo
      StringRequired

      The license product name.

    • hostNum
      IntegerRequired

      The number of host.

    • cpuNum
      IntegerRequired

      The number of CPUs.

    • availableHostNum
      IntegerRequired

      The number of available host.

    • availableCpuNum
      IntegerRequired

      The number of available CPU.

    • expired
      booleanRequired

      The expired.