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

查询分布式端口组

查询分布式端口组

调试可用性

在线调试

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

请求参数

此接口无需请求参数。

响应状态

200 OK

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

  • successboolean必填

    操作是否成功。

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • inventoriesList必填

    详情参考inventories

    • vSwitchUuidString必填

      虚拟交换机UUID

    • vlanIdInteger必填

      VLAN号

    • vlanRangesString必填

      VLAN范围

    • uuidString必填

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

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • typeString必填

      端口组类型

    • zoneUuidString必填

      数据中心UUID

    • l2NetworkUuidString必填

      端口组分布式交换机UUID

    • stateString必填

      状态

    • dnsDomainString必填

      DNS域

    • systemBoolean必填

      是否用于系统虚拟机

    • categoryString必填

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

    • ipVersionInteger必填

      IP协议号

    • enableIPAMBoolean必填

      IP地址管理是否启用

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • dnsList必填

      暂无描述。

    • vlanModePortGroupVlanMode必填

      详情参考vlanMode

      • ACCESSPortGroupVlanMode必填

        访问。

      • TRUNKPortGroupVlanMode必填

        暂无描述。

      • PVLANPortGroupVlanMode必填

        暂无描述。

    • ipRangesList必填

      详情参考ipRanges

      • uuidString必填

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

      • l3NetworkUuidString必填

        分布式端口组UUID

      • nameString必填

        资源名称

      • descriptionString必填

        资源的详细描述

      • startIpString必填

        起始地址

      • endIpString必填

        结束地址

      • netmaskString必填

        掩码

      • prefixLenString必填

        掩码长度

      • gatewayString必填

        网关

      • networkCidrString必填

        网络CIDR

      • ipVersionInteger必填

        IP协议号

      • addressModeString必填

        IPv6地址分配模式

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

      • ipRangeTypeIpRangeType必填

        详情参考ipRangeType

        • NormalIpRangeType必填

          普通地址段

        • AddressPoolIpRangeType必填

          地址池段

    • networkServicesList必填

      详情参考networkServices

      • l3NetworkUuidString必填

        分布式端口组UUID

      • networkServiceProviderUuidString必填

        网络服务提供模块UUID

      • networkServiceTypeString必填

        暂无描述。

    • hostRouteList必填

      详情参考hostRoute

      • idLong必填

        资源ID。

      • l3NetworkUuidString必填

        分布式端口组UUID

      • prefixString必填

        暂无描述。

      • nexthopString必填

        暂无描述。

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

请求地址

GET/zstack/v1/l3-networks/port-group

/zstack/v1/l3-networks/port-group

操作 ID

QueryPortGroup

永久链接

请求示例

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

响应示例

200
{ "inventories": [ { "vSwitchUuid": "5343e94b3aa93086b81c1b33c335b9ad", "vlanMode": "ACCESS", "vlanId": 100, "uuid": "01a9693135323cf1acb3049e8ddf50b2", "name": "port-group-1", "description": "Test", "type": "portGroup", "zoneUuid": "36712d24b27b327aae544095c768366b", "l2NetworkUuid": "49012f786210301697167b3771a65e8c", "state": "Enabled", "system": false, "category": "Private", "enableIPAM": false } ] }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史