Skip to main content
ZStack
Resource Center/Resource Pool/VM Instance Operations

GetVmAttachableL3Network

GetVmAttachableL3Network

GET/zstack/v1/vm-instances/{vmInstanceUuid}/l3-networks-candidates

Operation ID

GetVmAttachableL3Network

Since

0.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

  • vmInstanceUuid
    StringRequired

    The VM instance UUID.

Query Parameters

  • 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.

  • 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 detailed description of the resource.

    • type
      StringRequired

      The resource type.

    • zoneUuid
      StringRequired

      The zone UUID.

    • l2NetworkUuid
      StringRequired

      The L2 network UUID.

    • state
      StringRequired

      The resource state.

    • dnsDomain
      StringRequired

      The DNS domain.

    • system
      BooleanRequired

      The system.

    • category
      StringRequired

      The category.

    • ipVersion
      IntegerRequired

      The IP version.

    • createDate
      TimestampRequired

      The creation date.

    • lastOpDate
      TimestampRequired

      The last operation date.

    • dns
      ListRequired

      The DNS server address.

    • ipRanges
      ListRequired

      See ipRanges.

      • uuid
        StringRequired

        The resource UUID.

      • l3NetworkUuid
        StringRequired

        The L3 network UUID.

      • name
        StringRequired

        The resource name.

      • description
        StringRequired

        The detailed description of the resource.

      • startIp
        StringRequired

        The start IP.

      • endIp
        StringRequired

        The end IP.

      • netmask
        StringRequired

        The netmask.

      • prefixLen
        StringRequired

        The netmask length.

      • gateway
        StringRequired

        The gateway IP address.

      • networkCidr
        StringRequired

        The network cidr.

      • ipVersion
        IntegerRequired

        The IP version.

      • addressMode
        StringRequired

        The allocation mode of the IPv6 address.

      • createDate
        TimestampRequired

        The creation date.

      • lastOpDate
        TimestampRequired

        The last operation date.

    • networkServices
      ListRequired

      See networkServices.

      • l3NetworkUuid
        StringRequired

        The L3 network UUID.

      • networkServiceProviderUuid
        StringRequired

        The network service provider UUID.

      • networkServiceType
        StringRequired

        The network service type.

    • hostRoute
      ListRequired

      See hostRoute.

      • id
        LongRequired

        The resource ID.

      • l3NetworkUuid
        StringRequired

        The L3 network UUID.

      • prefix
        StringRequired

        The prefix.

      • nexthop
        StringRequired

        The next hop.

      • createDate
        TimestampRequired

        The creation date.

      • lastOpDate
        TimestampRequired

        The last operation date.