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

查询IP地址池

查询IP地址池

GET/zstack/v1/l3-networks/address-pools
GET/zstack/v1/l3-networks/address-pools/{uuid}

操作 ID

QueryAddressPool

起始版本

3.9.0

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

查询参数

  • q
    String

    查询条件。

响应状态

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

  • inventories
    List必填

    详情参考inventories

    • uuid
      String必填

      资源的UUID，唯一标示该资源

    • l3NetworkUuid
      String必填

      三层网络UUID

    • name
      String必填

      资源名称

    • description
      String必填

      资源的详细描述

    • startIp
      String必填

      起始IP

    • endIp
      String必填

      结束IP

    • netmask
      String必填

      掩码

    • gateway
      String必填

      网关

    • networkCidr
      String必填

      网络CIDR

    • ipVersion
      Integer必填

      ip协议号

    • addressMode
      String必填

      IPv6地址分配模式

    • prefixLen
      Integer必填

      掩码长度

    • createDate
      Timestamp必填

      创建时间

    • lastOpDate
      Timestamp必填

      最后一次修改时间

    • ipRangeType
      IpRangeType必填

      详情参考ipRangeType

      • Normal
        IpRangeType必填

        普通地址段

      • AddressPool
        IpRangeType必填

        地址池段