跳转到主要内容
API Explorer|API Explorer
资源中心/网络资源/VPC相关接口
GETVPC Operations起始版本 0.6同步需要认证

查询VPC路由器

查询VPC路由器

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

请求参数

此接口无需请求参数。

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • errorErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • codeString必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

  • inventoriesList必填

    详情参考inventories

    • publicNetworkUuidString必填

      暂无描述。

    • virtualRouterVipsList必填

      暂无描述。

    • applianceVmTypeString必填

      设备云主机类型。

    • managementNetworkUuidString必填

      暂无描述。

    • defaultRouteL3NetworkUuidString必填

      暂无描述。

    • statusString必填

      状态信息。

    • agentPortInteger必填

      代理端口。

    • uuidString必填

      资源的UUID，唯一标示该资源

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • zoneUuidString必填

      区域UUID

    • clusterUuidString必填

      集群UUID

    • imageUuidString必填

      镜像UUID

    • hostUuidString必填

      物理机UUID

    • lastHostUuidString必填

      最近一次主机UUID。

    • instanceOfferingUuidString必填

      计算规格UUID

    • rootVolumeUuidString必填

      根云盘UUID

    • platformString必填

      平台。

    • defaultL3NetworkUuidString必填

      暂无描述。

    • typeString必填

      类型。

    • hypervisorTypeString必填

      暂无描述。

    • memorySizeLong必填

      内存大小。

    • cpuNumInteger必填

      暂无描述。

    • cpuSpeedLong必填

      暂无描述。

    • allocatorStrategyString必填

      暂无描述。

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • stateString必填

      当前状态。

    • dnsList必填

      详情参考dns

      • vpcRouterUuidString必填

        暂无描述。

      • dnsString必填

        暂无描述。

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

    • vmNicsList必填

      详情参考vmNics

      • uuidString必填

        资源的UUID，唯一标示该资源

      • vmInstanceUuidString必填

        云主机UUID

      • l3NetworkUuidString必填

        三层网络UUID

      • ipString必填

        来源IP地址。

      • macString必填

        暂无描述。

      • netmaskString必填

        暂无描述。

      • gatewayString必填

        暂无描述。

      • metaDataString必填

        元数据。

      • deviceIdInteger必填

        设备ID。

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

    • allVolumesList必填

      详情参考allVolumes

      • uuidString必填

        资源的UUID，唯一标示该资源

      • nameString必填

        资源名称

      • descriptionString必填

        资源的详细描述

      • primaryStorageUuidString必填

        主存储UUID

      • vmInstanceUuidString必填

        云主机UUID

      • diskOfferingUuidString必填

        云盘规格UUID

      • rootImageUuidString必填

        根镜像UUID。

      • installPathString必填

        安装路径。

      • typeString必填

        类型。

      • formatString必填

        数据格式或导出格式。

      • sizeLong必填

        返回记录数。

      • actualSizeLong必填

        实际大小。

      • deviceIdInteger必填

        设备ID。

      • stateString必填

        当前状态。

      • statusString必填

        状态信息。

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

      • isShareableBoolean必填

        是否可分享。

请求地址

GET/zstack/v1/vpc/virtual-routers

/zstack/v1/vpc/virtual-routers

操作 ID

QueryVpcRouter

永久链接

请求示例

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

响应示例

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" } ] } ] }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史