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

获取可绑定指定弹性IP的云主机网卡

获取可绑定指定弹性IP的云主机网卡

GET/zstack/v1/eips/{eipUuid}/vm-instances/candidate-nics

操作 ID

GetEipAttachableVmNics

起始版本

0.6

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

路径参数

  • eipUuid
    String

    弹性IP UUID

查询参数

  • vipUuid
    String

    可选VIP UUID。

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

    • vmInstanceUuid
      String必填

      云主机UUID

    • l3NetworkUuid
      String必填

      三层网络UUID

    • ip
      String必填

      来源IP地址。

    • mac
      String必填

      MAC地址。

    • netmask
      String必填

      暂无描述。

    • gateway
      String必填

      网关IP地址。

    • metaData
      String必填

      元数据。

    • ipVersion
      Integer必填

      ip协议号

    • deviceId
      Integer必填

      设备ID。

    • createDate
      Timestamp必填

      创建时间

    • lastOpDate
      Timestamp必填

      最后一次修改时间

    • usedIps
      List必填

      详情参考usedIps

      • uuid
        String必填

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

      • ipRangeUuid
        String必填

        IP段UUID

      • l3NetworkUuid
        String必填

        三层网络UUID

      • ipVersion
        Integer必填

        IP协议号

      • ip
        String必填

        IP地址

      • netmask
        String必填

        网络掩码

      • gateway
        String必填

        网关地址

      • usedFor
        String必填

        intended使用。

      • ipInLong
        long必填

        IP地址represented长integer。

      • vmNicUuid
        String必填

        云主机网卡UUID

      • createDate
        Timestamp必填

        创建时间

      • lastOpDate
        Timestamp必填

        最后一次修改时间