Skip to main content
ZStack
Resource Center/Network Service/Network Service Operations/EIP Operations

GetVmNicAttachableEips

GetVmNicAttachableEips

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

Operation ID

GetVmNicAttachableEips

Since

4.4.6

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

Path Parameters

  • vmNicUuid
    StringRequired

    The VM NIC UUID.

Query Parameters

  • ipVersion
    Integer

    Optional. The IP version.

  • limit
    Integer

    Optional. The limit of the returned results.

  • start
    Integer

    Optional. The start position of the query.

  • systemTags
    List

    Optional. The system tags.

  • userTags
    List

    Optional. The user tags.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • success
    booleanRequired

    Whether the operation succeeded.

  • error
    ErrorCodeRequired

    The error code. If not null, the operation fails, or vice versa. For more information, see error.

    • code
      StringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • description
      StringRequired

      The brief description of the error.

    • details
      StringRequired

      The details about the error.

    • elaboration
      StringRequired

      The reserved field. Default value: null.

    • opaque
      LinkedHashMapRequired

      The reserved field. Default value: null.

    • cause
      ErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

  • inventories
    ListRequired

    See inventories.

    • uuid
      StringRequired

      The resource UUID.

    • name
      StringRequired

      The resource name.

    • description
      StringRequired

      The resource description.

    • vmNicUuid
      StringRequired

      The VM NIC UUID.

    • vipUuid
      StringRequired

      The VIP UUID.

    • createDate
      TimestampRequired

      The creation date.

    • lastOpDate
      TimestampRequired

      The last operation date.

    • state
      StringRequired

      The resource state.

    • vipIp
      StringRequired

      The VIP IP.

    • guestIp
      StringRequired

      The guest IP.