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

QueryVpcRouter

QueryVpcRouter

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.

    • publicNetworkUuidStringRequired

      No description provided.

    • virtualRouterVipsListRequired

      No description provided.

    • 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

      当前状态。

    • dnsListRequired

      See dns.

      • vpcRouterUuidStringRequired

        No description provided.

      • dnsStringRequired

        No description provided.

      • createDateTimestampRequired

        The creation date.

      • lastOpDateTimestampRequired

        The last operation date.

    • 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/vpc/virtual-routers

/zstack/v1/vpc/virtual-routers

Operation ID

QueryVpcRouter

Permalink

Request Example

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

Response Example

200
{ "inventories": [ { "dns": [ { "vpcRouterUuid": "4183325c367d384a84458f89c35d62a8", "dns": "8.8.8.8" } ], "uuid": "4183325c367d384a84458f89c35d62a8", "name": "Test-VM", "description": "web server VM", "zoneUuid": "77689ed989253db0bb5863b103e06ecd", "clusterUuid": "7f124c177f1535cebca9b0a555998e8e", "imageUuid": "9e0eaf2e7ea93bc0bfc9f22d3f7328cd", "hostUuid": "72547613a0bf320caca7a149d99e3ed4", "lastHostUuid": "9e54bc8261f6396db6c66eb8a76e246d", "instanceOfferingUuid": "e115b1542d2e35c8b9fbb5afd9fd067c", "rootVolumeUuid": "48afbfcc2d36391586f7b6b44df93712", "platform": "Linux", "defaultL3NetworkUuid": "70dc6311679638c0a1e323d583332463", "type": "UserVm", "hypervisorType": "KVM", "memorySize": 8.589934592E9, "cpuNum": 1.0, "allocatorStrategy": "LastHostPreferredAllocatorStrategy", "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM", "state": "Running", "vmNics": [ { "uuid": "df1eae8361983c86a46d3d922ad0a6f4", "vmInstanceUuid": "4183325c367d384a84458f89c35d62a8", "usedIpUuid": "2bdc1a927ebb34f89a880d8aefc7c763", "l3NetworkUuid": "70dc6311679638c0a1e323d583332463", "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": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM" } ], "allVolumes": [ { "uuid": "48afbfcc2d36391586f7b6b44df93712", "name": "Root-Volume-For-VM-4183325c367d384a84458f89c35d62a8", "primaryStorageUuid": "a33d58803a2a307bb1762b9209e64ba2", "vmInstanceUuid": "4183325c367d384a84458f89c35d62a8", "diskOfferingUuid": "c762d59a3e6f36d89bff2ce3ea4b864c", "rootImageUuid": "9e0eaf2e7ea93bc0bfc9f22d3f7328cd", "installPath": "/Cloud_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-48afbfcc2d36391586f7b6b44df93712/48afbfcc2d36391586f7b6b44df93712.qcow2", "type": "Root", "format": "qcow2", "size": 1.073741824E11, "actualSize": 2.147483648E10, "deviceId": 0.0, "state": "Enabled", "status": "Ready", "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM" } ] } ] }

Change History

This API has no change history records yet.

View all change history