跳转到主要内容
ZStack
资源中心/网络服务/网络服务相关接口/虚拟IP相关接口

获取虚拟IP所有业务端口列表

获取虚拟IP上所有业务的端口列表。业务类型包含负载均衡、端口转发、IPsec隧道。

GET/zstack/v1/vips/{uuid}/usedports

操作 ID

GetVipUsedPorts

起始版本

2.2

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

路径参数

  • uuid
    String必填

    资源UUID。

查询参数

  • uuid
    String必填

    资源的UUID，唯一标识该资源。

  • protocol
    String必填

    协议

  • systemTags
    List

    系统标签。

  • userTags
    List

    用户标签。

响应状态

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，唯一标识该资源。

    • protcol
      String必填

      暂无描述。

    • usedPorts
      List必填

      已使用ports。