Skip to main content
API Explorer|API Explorer
Resource Center/Network Resource/Route Resource Operations
GETRoute Resource OperationsSince 0.6SynchronousAuth Required

QueryVirtualRouterVm

QueryVirtualRouterVm

Execution Availability

Try It Out

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

Request Inputs

This API requires no request parameters.

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.

    • applianceVmTypeStringRequired

      设备云主机类型。

    • managementNetworkUuidStringRequired

      No description provided.

    • defaultRouteL3NetworkUuidStringRequired

      No description provided.

    • statusStringRequired

      状态信息。

    • agentPortIntegerRequired

      代理端口。

    • uuidStringRequired

      The resource UUID.

    • nameStringRequired

      The resource name.

    • descriptionStringRequired

      The detailed description of the resource.

    • zoneUuidStringRequired

      The zone UUID.

    • clusterUuidStringRequired

      The cluster UUID.

    • imageUuidStringRequired

      The image UUID.

    • hostUuidStringRequired

      The host UUID.

    • lastHostUuidStringRequired

      最近一次主机UUID。

    • instanceOfferingUuidStringRequired

      The instance offering UUID.

    • rootVolumeUuidStringRequired

      The root volume UUID.

    • platformStringRequired

      平台。

    • defaultL3NetworkUuidStringRequired

      No description provided.

    • typeStringRequired

      类型。

    • hypervisorTypeStringRequired

      No description provided.

    • memorySizeLongRequired

      内存大小。

    • cpuNumIntegerRequired

      No description provided.

    • cpuSpeedLongRequired

      No description provided.

    • allocatorStrategyStringRequired

      No description provided.

    • createDateTimestampRequired

      The creation date.

    • lastOpDateTimestampRequired

      The last operation date.

    • stateStringRequired

      当前状态。

    • vmNicsListRequired

      See vmNics.

      • uuidStringRequired

        The resource UUID.

      • vmInstanceUuidStringRequired

        The VM instance UUID.

      • l3NetworkUuidStringRequired

        The L3 network UUID.

      • ipStringRequired

        来源IP地址。

      • macStringRequired

        No description provided.

      • netmaskStringRequired

        No description provided.

      • gatewayStringRequired

        No description provided.

      • metaDataStringRequired

        元数据。

      • deviceIdIntegerRequired

        设备ID。

      • createDateTimestampRequired

        The creation date.

      • lastOpDateTimestampRequired

        The last operation date.

    • allVolumesListRequired

      See allVolumes.

      • uuidStringRequired

        The resource UUID.

      • nameStringRequired

        The resource name.

      • descriptionStringRequired

        The detailed description of the resource.

      • primaryStorageUuidStringRequired

        The primary storage UUID.

      • vmInstanceUuidStringRequired

        The VM instance UUID.

      • diskOfferingUuidStringRequired

        The disk offering UUID.

      • rootImageUuidStringRequired

        根镜像UUID。

      • installPathStringRequired

        安装路径。

      • typeStringRequired

        类型。

      • formatStringRequired

        数据格式或导出格式。

      • sizeLongRequired

        返回记录数。

      • actualSizeLongRequired

        实际大小。

      • deviceIdIntegerRequired

        设备ID。

      • stateStringRequired

        当前状态。

      • statusStringRequired

        状态信息。

      • createDateTimestampRequired

        The creation date.

      • lastOpDateTimestampRequired

        The last operation date.

      • isShareableBooleanRequired

        是否可分享。

Endpoint

GET/zstack/v1/vm-instances/appliances/virtual-routers

/zstack/v1/vm-instances/appliances/virtual-routers

Operation ID

QueryVirtualRouterVm

Permalink

Request Example

curl -X GET 'http://{host}/zstack/v1/vm-instances/appliances/virtual-routers' -H 'Authorization: OAuth {sessionUuid}'

Response Example

200
{ "inventories": [ { "uuid": "eb4c132875424e19aa200c5685f7d9ca", "name": "Test-VM", "description": "Appliance VM", "zoneUuid": "453595b58b1f407aa8b551c279738191", "clusterUuid": "bc24a488a7c740ef828839d6624b15a2", "imageUuid": "729f3c664fb14ffa8886cbf5d14bec47", "hostUuid": "bdd8a04c22b6482287a2ac071319f59d", "lastHostUuid": "bc6337a5a73142c8afbc4108f69595cf", "instanceOfferingUuid": "5beedb45ba9547a4a154c747c69c38bd", "rootVolumeUuid": "b07d68c5879b49a680f6fc375d06603f", "platform": "Linux", "defaultL3NetworkUuid": "dfd914d7f33a434a880fd0cd29db1ad1", "type": "UserVm", "hypervisorType": "KVM", "memorySize": 8.589934592E9, "cpuNum": 1.0, "allocatorStrategy": "LastHostPreferredAllocatorStrategy", "createDate": "Jun 7, 2017 9:21:17 PM", "lastOpDate": "Jun 7, 2017 9:21:17 PM", "state": "Running", "vmNics": [ { "uuid": "ba1a965bee39412c962735987da7722a", "vmInstanceUuid": "eb4c132875424e19aa200c5685f7d9ca", "usedIpUuid": "7250d89102a44251aa49a5bcf093d484", "l3NetworkUuid": "dfd914d7f33a434a880fd0cd29db1ad1", "ip": "192.168.1.10", "mac": "00:0c:29:bd:99:fc", "netmask": "255.255.255.0", "gateway": "192.168.1.1", "deviceId": 0.0, "createDate": "Jun 7, 2017 9:21:17 PM", "lastOpDate": "Jun 7, 2017 9:21:17 PM" } ], "allVolumes": [ { "uuid": "b07d68c5879b49a680f6fc375d06603f", "name": "Root-Volume-For-VM-eb4c132875424e19aa200c5685f7d9ca", "primaryStorageUuid": "f82bd3273e1a42a7bc53f1d098d07c63", "vmInstanceUuid": "eb4c132875424e19aa200c5685f7d9ca", "diskOfferingUuid": "71a6bbc236974c188ad258875a0cc837", "rootImageUuid": "729f3c664fb14ffa8886cbf5d14bec47", "installPath": "/Cloud_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-b07d68c5879b49a680f6fc375d06603f/b07d68c5879b49a680f6fc375d06603f.qcow2", "type": "Root", "format": "qcow2", "size": 1.073741824E11, "actualSize": 2.147483648E10, "deviceId": 0.0, "state": "Enabled", "status": "Ready", "createDate": "Jun 7, 2017 9:21:17 PM", "lastOpDate": "Jun 7, 2017 9:21:17 PM" } ] } ] }

Change History

This API has no change history records yet.

View all change history