跳转到主要内容
ZStack
资源中心/弹性裸金属管理(Plus)

获取部署网络IP地址可用量

获取部署网络IP地址可用量

GET/zstack/v1/baremetal2/provision-networks/ip-capacity

操作 ID

GetBareMetal2ProvisionNetworkIpAddressCapacity

起始版本

4.0.0

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

查询参数

  • networkUuids
    List必填

    裸金属部署网络UUID列表

  • systemTags
    List

    系统标签

  • userTags
    List

    用户标签

响应状态

200 OK
200 OK

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

  • success
    boolean必填

    获取成功

  • capacityData
    List必填

    详情参考capacityData

    • networkUuid
      String必填

      裸金属部署网络UUID

    • totalCapacity
      long必填

      IP总量

    • availableCapacity
      long必填

      IP可用量

    • gatewayUsedIpNumber
      long必填

      裸金属网关节点占用IP数量

    • instanceUsedIpNumber
      long必填

      裸金属实例占用IP数量

  • error
    ErrorCode必填

    详情参考error

    • code
      String必填

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

    • description
      String必填

      错误的概要描述

    • details
      String必填

      错误的详细信息

    • elaboration
      String必填

      保留字段，默认为null

    • opaque
      LinkedHashMap必填

      保留字段，默认为null

    • cause
      ErrorCode必填

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