跳转到主要内容
API Explorer|API Explorer
资源中心/弹性裸金属管理(Plus)
GETElastic Bare Metal Management(Plus)起始版本 4.0.0同步需要认证

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

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

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

查询参数

请求参数

查询参数

  • networkUuidsList必填

    裸金属部署网络UUID列表

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

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

  • successboolean必填

    获取成功

  • capacityDataList必填

    详情参考capacityData

    • networkUuidString必填

      裸金属部署网络UUID

    • totalCapacitylong必填

      IP总量

    • availableCapacitylong必填

      IP可用量

    • gatewayUsedIpNumberlong必填

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

    • instanceUsedIpNumberlong必填

      裸金属实例占用IP数量

  • errorErrorCode必填

    详情参考error

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

请求地址

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

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

操作 ID

GetBareMetal2ProvisionNetworkIpAddressCapacity

永久链接

请求示例

curl -X GET 'http://{host}/zstack/v1/baremetal2/provision-networks/ip-capacity?networkUuids=<networkUuids>&systemTags=<systemTags>&userTags=<userTags>' -H 'Authorization: OAuth {sessionUuid}'

响应示例

200
{ "capacityData": [ { "networkUuid": "da4ac0c888fc34b399a343140780a627", "totalCapacity": 100.0, "availableCapacity": 50.0, "gatewayUsedIpNumber": 10.0, "instanceUsedIpNumber": 40.0 } ] }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史