跳转到主要内容
ZStack
系统全局相关/许可证相关接口

获取许可证信息

获取许可证信息

GET/zstack/v1/licenses

操作 ID

GetLicenseInfo

起始版本

4.1.0

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

查询参数

  • additionSession
    String

    额外的信息,是一个json字符串

  • systemTags
    List

    系统标签

  • userTags
    List

    用户标签

响应状态

200 OK
200 OK

该 API 成功时返回以下响应结构。

  • error
    ErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • code
      String必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • description
      String必填

      错误的概要描述

    • details
      String必填

      错误的详细信息

    • elaboration
      String必填

      保留字段，默认为null

    • opaque
      LinkedHashMap必填

      保留字段，默认为null

    • cause
      ErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

  • inventory
    LicenseInventory必填

    详情参考inventory

    • licenseType
      String必填

      许可证类型。

    • licenseRequest
      String必填

      许可证请求。

    • expiredDate
      String必填

      已过期时间。

    • issuedDate
      String必填

      已签发时间。

    • user
      String必填

      用户信息。

    • prodInfo
      String必填

      许可证产品名称

    • hostNum
      Integer必填

      数量主机。

    • cpuNum
      Integer必填

      暂无描述。

    • availableHostNum
      Integer必填

      数量可用主机。

    • availableCpuNum
      Integer必填

      数量可用CPU。

    • expired
      boolean必填

      已过期。