Skip to main content
API Explorer|API Explorer
Resource Center/Resource Pool/VM Instance Operations
GETVM Instance OperationsSince 0.6SynchronousAuth Required

GetVmAttachableL3Network

GetVmAttachableL3Network

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Query Parameters

Request Inputs

Path Parameters

  • vmInstanceUuidStringRequired

    The VM instance UUID.

Query Parameters

  • systemTagsList

    Optional. The system tags.

  • userTagsList

    Optional. The user tags.

Responses

200 OK

On success, this API returns the following response structure.

  • errorErrorCodeRequired

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

    • codeStringRequired

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

    • descriptionStringRequired

      The brief description of the error.

    • detailsStringRequired

      The details about the error.

    • elaborationStringRequired

      The reserved field. Default value: null.

    • opaqueLinkedHashMapRequired

      The reserved field. Default value: null.

    • causeErrorCodeRequired

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

  • inventoriesListRequired

    See inventories.

    • uuidStringRequired

      The resource UUID.

    • nameStringRequired

      The resource name.

    • descriptionStringRequired

      The detailed description of the resource.

    • typeStringRequired

      类型。

    • zoneUuidStringRequired

      The zone UUID.

    • l2NetworkUuidStringRequired

      The L2 network UUID.

    • stateStringRequired

      当前状态。

    • dnsDomainStringRequired

      DNS域。

    • systemBooleanRequired

      系统。

    • categoryStringRequired

      类型分类。

    • ipVersionIntegerRequired

      The IP version.

    • createDateTimestampRequired

      The creation date.

    • lastOpDateTimestampRequired

      The last operation date.

    • dnsListRequired

      No description provided.

    • ipRangesListRequired

      See ipRanges.

      • uuidStringRequired

        The resource UUID.

      • l3NetworkUuidStringRequired

        The L3 network UUID.

      • nameStringRequired

        The resource name.

      • descriptionStringRequired

        The detailed description of the resource.

      • startIpStringRequired

        开始IP。

      • endIpStringRequired

        结束IP。

      • netmaskStringRequired

        No description provided.

      • prefixLenStringRequired

        The netmask length.

      • gatewayStringRequired

        No description provided.

      • networkCidrStringRequired

        No description provided.

      • ipVersionIntegerRequired

        The IP version.

      • addressModeStringRequired

        The allocation mode of the IPv6 address.

      • createDateTimestampRequired

        The creation date.

      • lastOpDateTimestampRequired

        The last operation date.

    • networkServicesListRequired

      See networkServices.

      • l3NetworkUuidStringRequired

        The L3 network UUID.

      • networkServiceProviderUuidStringRequired

        The network service provider UUID.

      • networkServiceTypeStringRequired

        No description provided.

    • hostRouteListRequired

      See hostRoute.

      • idLongRequired

        资源ID。

      • l3NetworkUuidStringRequired

        The L3 network UUID.

      • prefixStringRequired

        No description provided.

      • nexthopStringRequired

        No description provided.

      • createDateTimestampRequired

        The creation date.

      • lastOpDateTimestampRequired

        The last operation date.

Endpoint

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

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

Operation ID

GetVmAttachableL3Network

Permalink

Request Example

curl -X GET 'http://{host}/zstack/v1/vm-instances/{vmInstanceUuid}/l3-networks-candidates?systemTags=<systemTags>&userTags=<userTags>' -H 'Authorization: OAuth {sessionUuid}'

Response Example

200
{ "inventories": [ { "uuid": "d2f77ca69b1448d3b8e063c3d551cf1b", "name": "private L3", "type": "L3BasicNetwork", "zoneUuid": "67a6601dc8dd476ebca371123ff03f14", "l2NetworkUuid": "94bdffb080b346e7a3ac2f44f574cc4a", "state": "Enabled", "createDate": "Apr 24, 2017 7:11:08 PM", "lastOpDate": "Apr 24, 2017 7:11:08 PM", "ipRanges": [ { "uuid": "e15972969ac64d1ea01c0c228d969bcc", "l3NetworkUuid": "d2f77ca69b1448d3b8e063c3d551cf1b", "name": "ip range", "startIp": "192.168.0.10", "endIp": "192.168.0.100", "netmask": "255.255.255.0", "gateway": "192.168.0.1", "createDate": "Apr 24, 2017 7:11:08 PM", "lastOpDate": "Apr 24, 2017 7:11:08 PM" } ], "networkServices": [ { "l3NetworkUuid": "d2f77ca69b1448d3b8e063c3d551cf1b", "networkServiceProviderUuid": "a493b6286d6e43f89e06062b7a4ad182", "networkServiceType": "DHCP" }, { "l3NetworkUuid": "d2f77ca69b1448d3b8e063c3d551cf1b", "networkServiceProviderUuid": "a493b6286d6e43f89e06062b7a4ad182", "networkServiceType": "DNS" }, { "l3NetworkUuid": "d2f77ca69b1448d3b8e063c3d551cf1b", "networkServiceProviderUuid": "a493b6286d6e43f89e06062b7a4ad182", "networkServiceType": "SNAT" } ] } ] }

Change History

This API has no change history records yet.

View all change history