跳转到主要内容
资源中心/网络资源/三层网络相关接口

获取三层网络IP地址使用情况统计

获取三层网络IP地址使用情况统计

GET/zstack/v1/l3-networks/{l3NetworkUuid}/ip-statistic

操作 ID

GetL3NetworkIpStatistic

起始版本

3.7.0

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

路径参数

  • l3NetworkUuid
    String必填

    三层网络UUID

查询参数

  • resourceType
    String

    统计资源类型

  • ip
    String

    指定IP地址

  • sortBy
    String

    排序方式

  • sortDirection
    String

    排序方向

  • start
    Integer

    统计结果起始位置

响应状态

200 OK
200 OK

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

  • total
    Long必填

    IP统计结果总数

  • success
    boolean必填

    成功

  • error
    ErrorCode必填

    详情参考error

    • code
      String必填

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

    • description
      String必填

      错误的概要描述

    • details
      String必填

      错误的详细信息

    • elaboration
      String必填

      保留字段,默认为null

    • opaque
      LinkedHashMap必填

      保留字段,默认为null

    • cause
      ErrorCode必填

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

  • ipStatistics
    List必填

    详情参考ipStatistics

    • ip
      String必填

      IP地址

    • vipUuid
      String必填

      虚拟IP的UUID

    • vipName
      String必填

      虚拟IP名字

    • vmInstanceUuid
      String必填

      虚拟机实例UUID

    • vmInstanceName
      String必填

      虚拟机实例名字

    • vmInstanceType
      String必填

      虚拟机实例类型

    • vmDefaultIp
      String必填

      虚拟机实例默认IP

    • resourceTypes
      List必填

      绑定到IP地址的资源类型列表

    • state
      String必填

      资源状态

    • useFor
      String必填

      虚拟IP绑定的网络服务

    • createDate
      Timestamp必填

      创建时间

    • ownerName
      String必填

      资源所有者名字

  • error
    ErrorCode必填

    详情参考error

    • code
      String必填

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

    • description
      String必填

      错误的概要描述

    • details
      String必填

      错误的详细信息

    • elaboration
      String必填

      保留字段,默认为null

    • opaque
      LinkedHashMap必填

      保留字段,默认为null

    • cause
      ErrorCode必填

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