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

查询IP地址池

查询IP地址池

调试可用性

在线调试

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

请求参数

此接口无需请求参数。

响应状态

200 OK

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

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • inventoriesList必填

    详情参考inventories

    • uuidString必填

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

    • l3NetworkUuidString必填

      三层网络UUID

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • startIpString必填

      起始IP

    • endIpString必填

      结束IP

    • netmaskString必填

      掩码

    • gatewayString必填

      网关

    • networkCidrString必填

      网络CIDR

    • ipVersionInteger必填

      ip协议号

    • addressModeString必填

      IPv6地址分配模式

    • prefixLenInteger必填

      掩码长度

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • ipRangeTypeIpRangeType必填

      详情参考ipRangeType

      • NormalIpRangeType必填

        普通地址段

      • AddressPoolIpRangeType必填

        地址池段

请求地址

GET/zstack/v1/l3-networks/address-pools

/zstack/v1/l3-networks/address-pools

操作 ID

QueryAddressPool

永久链接

请求示例

curl -X GET 'http://{host}/zstack/v1/l3-networks/address-pools' -H 'Authorization: OAuth {sessionUuid}'

响应示例

200
{ "inventories": [ { "l3NetworkUuid": "81ce7828f3f63c0ea8a69dd9139bdaa0", "name": "Test-IPRange", "networkCidr": "192.168.10.0/24", "ipRangeType": "AddressPool" } ] }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史