跳转到主要内容
API Explorer|API Explorer
资源中心/网络资源/三层网络相关接口
GETL3 Network Operations起始版本 0.6同步需要认证

获取IP网络地址容量

获取IP网络地址容量

调试可用性

在线调试

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

查询参数

请求参数

查询参数

  • zoneUuidsList

    区域UUID

  • l3NetworkUuidsList

    三层网络UUID

  • ipRangeUuidsList

    IP地址范围UUID

  • allboolean

    系统全局

  • systemTagsList

    系统标签

响应状态

200 OK

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

  • totalCapacitylong必填

    IP地址容量

  • availableCapacitylong必填

    可用IP地址容量

  • usedIpAddressNumberLong必填

    已使用IP数量

  • ipv4TotalCapacitylong必填

    IPv4地址容量

  • ipv4AvailableCapacitylong必填

    可用IPv4地址容量

  • ipv4UsedIpAddressNumberlong必填

    已使用IPv4数量

  • ipv6TotalCapacitylong必填

    IPv6地址容量

  • ipv6AvailableCapacitylong必填

    可用IPv6地址容量

  • ipv6UsedIpAddressNumberlong必填

    已使用IPv6数量

  • resourceTypeString必填

    所查询资源的类型（地址范围、三层网络、区域）

  • successboolean必填

    成功

  • errorErrorCode必填

    详情参考error

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • capacityDataList必填

    详情参考capacityData

    • resourceUuidString必填

      资源UUID

    • totalCapacitylong必填

      IP地址总容量

    • availableCapacitylong必填

      可用IP地址容量

    • usedIpAddressNumberlong必填

      已用IP地址容量

    • ipv4TotalCapacitylong必填

      IPv4地址总容量

    • ipv4AvailableCapacitylong必填

      可用IPv4地址容量

    • ipv4UsedIpAddressNumberlong必填

      已用IPv4地址容量

    • ipv6TotalCapacitylong必填

      IPv6地址总容量

    • ipv6AvailableCapacitylong必填

      可用IPv6地址容量

    • ipv6UsedIpAddressNumberlong必填

      已用IPv6地址容量

  • errorErrorCode必填

    详情参考error

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

请求地址

GET/zstack/v1/ip-capacity

/zstack/v1/ip-capacity

操作 ID

GetIpAddressCapacity

永久链接

请求示例

curl -X GET 'http://{host}/zstack/v1/ip-capacity?zoneUuids=<zoneUuids>&l3NetworkUuids=<l3NetworkUuids>&ipRangeUuids=<ipRangeUuids>&all=True&systemTags=<systemTags>&userTags=<userTags>' -H 'Authorization: OAuth {sessionUuid}'

响应示例

200
{ "totalCapacity": 20.0, "availableCapacity": 15.0, "usedIpAddressNumber": 5.0, "ipv4TotalCapacity": 0.0, "ipv4AvailableCapacity": 0.0, "ipv4UsedIpAddressNumber": 0.0, "ipv6TotalCapacity": 0.0, "ipv6AvailableCapacity": 0.0, "ipv6UsedIpAddressNumber": 0.0, "capacityData": [ { "resourceUuid": "68b9a1c74c4c33c7b818e4c14bdea0a7", "totalCapacity": 20.0, "availableCapacity": 15.0, "usedIpAddressNumber": 5.0, "ipv4TotalCapacity": 0.0, "ipv4AvailableCapacity": 0.0, "ipv4UsedIpAddressNumber": 0.0, "ipv6TotalCapacity": 0.0, "ipv6AvailableCapacity": 0.0, "ipv6UsedIpAddressNumber": 0.0 } ], "resourceType": "L3NetworkVO" }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史