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

查询三层网络

查询三层网络

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

操作 ID

QueryL3Network

起始版本

0.6

执行模式

同步

认证信息

需要认证

认证信息

调用该 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，唯一标示该资源

    • name
      String必填

      资源名称

    • description
      String必填

      资源的详细描述

    • type
      String必填

      三层网络类型

    • zoneUuid
      String必填

      区域UUID

    • l2NetworkUuid
      String必填

      二层网络UUID

    • state
      String必填

      三层网络的可用状态

    • dnsDomain
      String必填

      DNS域

    • system
      Boolean必填

      是否用于系统云主机

    • category
      String必填

      网络类型，需要与system标签搭配使用，system为true时可设置为Public、Private

    • ipVersion
      Integer必填

      ip协议号

    • createDate
      Timestamp必填

      创建时间

    • lastOpDate
      Timestamp必填

      最后一次修改时间

    • dns
      List必填

      域名解析服务器

    • ipRanges
      List必填

      详情参考ipRanges

      • uuid
        String必填

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

      • l3NetworkUuid
        String必填

        三层网络UUID

      • name
        String必填

        资源名称

      • description
        String必填

        资源的详细描述

      • startIp
        String必填

        开始IP。

      • endIp
        String必填

        结束IP。

      • netmask
        String必填

        暂无描述。

      • prefixLen
        String必填

        掩码长度

      • gateway
        String必填

        网关IP地址。

      • networkCidr
        String必填

        网络CIDR。

      • ipVersion
        Integer必填

        ip协议号

      • addressMode
        String必填

        IPv6地址分配模式

      • createDate
        Timestamp必填

        创建时间

      • lastOpDate
        Timestamp必填

        最后一次修改时间

    • networkServices
      List必填

      详情参考networkServices

      • l3NetworkUuid
        String必填

        三层网络UUID

      • networkServiceProviderUuid
        String必填

        网络服务提供模块UUID

      • networkServiceType
        String必填

        网络服务类型。

    • hostRoute
      List必填

      详情参考hostRoute

      • id
        Long必填

        资源ID。

      • l3NetworkUuid
        String必填

        三层网络UUID

      • prefix
        String必填

        暂无描述。

      • nexthop
        String必填

        下一个hop。

      • createDate
        Timestamp必填

        创建时间

      • lastOpDate
        Timestamp必填

        最后一次修改时间