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

获取空闲IP

获取空闲IP

GET/zstack/v1/l3-networks/ip/free
GET/zstack/v1/l3-networks/{l3NetworkUuid}/ip/free
GET/zstack/v1/l3-networks/ip-ranges/{ipRangeUuid}/ip/free

操作 ID

GetFreeIp

起始版本

0.6

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

查询参数

  • l3NetworkUuid
    String

    三层网络UUIDNote: l3NetworkUuid和ipRangeUuid二选一

  • ipRangeUuid
    String

    IP段UUIDNote: l3NetworkUuid和ipRangeUuid二选一

  • start
    String

    起始值

  • ipRangeType
    String

    地址类型

  • ipVersion
    Integer

    IP地址版本号

响应状态

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

  • inventory
    L3NetworkInventory必填

    详情参考inventory

    • ipRangeUuid
      String必填

      IP段UUID

    • ip
      String必填

      来源IP地址。

    • netmask
      String必填

      暂无描述。

    • gateway
      String必填

      网关IP地址。