跳转到主要内容
API Explorer|API Explorer
资源中心/网络服务/网络服务相关接口/弹性IP相关接口
GETEIP Operations起始版本 4.4.6同步需要认证

获取vmNic可绑定的EIp

获取vmNic可绑定的EIp

调试可用性

在线调试

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

路径参数

查询参数

请求参数

路径参数

  • vmNicUuidString必填

    云主机网卡UUID

查询参数

  • ipVersionInteger

    IP地址版本

  • limitInteger

    统计结果数量

  • startInteger

    起始查询记录位置

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

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

  • successboolean必填

    操作是否成功。

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • inventoriesList必填

    详情参考inventories

    • uuidString必填

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

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • vmNicUuidString必填

      云主机网卡UUID

    • vipUuidString必填

      暂无描述。

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • stateString必填

      当前状态。

    • vipIpString必填

      暂无描述。

    • guestIpString必填

      暂无描述。

请求地址

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

/zstack/v1/vm-instances/nics/{vmNicUuid}/candidate-eips

操作 ID

GetVmNicAttachableEips

永久链接

请求示例

curl -X GET 'http://{host}/zstack/v1/vm-instances/nics/{vmNicUuid}/candidate-eips?ipVersion=1&limit=1&start=1&systemTags=<systemTags>&userTags=<userTags>' -H 'Authorization: OAuth {sessionUuid}'

响应示例

200
{ "inventories": [ { "uuid": "fe174df8c1003e3a9f13aa73104f45ee", "name": "eip", "vmNicUuid": "d29fb63d5aba4bbf98ec8663d6b4ba21", "vipUuid": "a5cfe85eb0d7448fbe153360c52114ce", "createDate": "Nov 14, 2017 9:20:57 AM", "lastOpDate": "Nov 14, 2017 9:20:57 AM", "state": "Enable", "vipIp": "10.72.109.11", "guestIp": "172.168.1.1" } ] }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史