跳转到主要内容
网络管理/网络资源/分布式端口组相关接口
GETDistributed Port Group Related Interfaces起始版本 0.6同步需要认证

获取空闲IP

获取空闲IP

调试可用性

在线调试

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

查询参数

请求参数

查询参数

  • l3NetworkUuidString

    分布式端口组UUIDNote: l3NetworkUuid和ipRangeUuid二选一

  • ipRangeUuidString

    IP段UUIDNote: l3NetworkUuid和ipRangeUuid二选一

  • startString

    起始值

  • ipRangeTypeString

    地址类型

  • ipVersionInteger

    IP地址版本号

响应状态

200 OK

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

  • errorErrorCode必填

    错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error

  • inventoryL3NetworkInventory必填

    详情参考inventory

  • codeString必填

    编码值。

  • descriptionString必填

    资源的详细描述。

  • detailsString必填

    详细信息。

  • elaborationString必填

    已预留字段默认值空。

  • opaqueLinkedHashMap必填

    已预留字段默认值空。

  • causeErrorCode必填

    暂无描述。

  • ipRangeUuidString必填

    IP范围UUID。

  • ipString必填

    来源IP地址。

  • netmaskString必填

    暂无描述。

  • gatewayString必填

    暂无描述。

请求地址

GET/zstack/v1/l3-networks/ip/free

/zstack/v1/l3-networks/ip/free

操作 ID

GetFreeIp

永久链接

请求示例

curl -X GET 'http://{host}/zstack/v1/l3-networks/ip/free?l3NetworkUuid=<l3NetworkUuid>&ipRangeUuid=<ipRangeUuid>&start=<start>&ipRangeType=<ipRangeType>&ipVersion=1&limit=1&systemTags=<systemTags>&userTags=<userTags>' -H 'Authorization: OAuth {sessionUuid}'

响应示例

200
{ "inventories": [ { "ipRangeUuid": "662d600a4b644f98a0c49df2e5430d69", "ip": "10.20.10.5", "netmask": "255.255.255.0", "gateway": "10.20.10.1" }, { "ipRangeUuid": "662d600a4b644f98a0c49df2e5430d69", "ip": "10.20.10.6", "netmask": "255.255.255.0", "gateway": "10.20.10.1" }, { "ipRangeUuid": "662d600a4b644f98a0c49df2e5430d69", "ip": "10.20.10.10", "netmask": "255.255.255.0", "gateway": "10.20.10.1" } ] }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史