ZStack Cloud Documentation
All
All
ZStack 3.10.0>API Reference>Network Resource>Route Resource Operations
Get PDF

ReconnectVirtualRouter

API Request

URLs
PUT zstack/v1/vm-instances/appliances/virtual-routers/{vmInstanceUuid}/actions
Headers
Authorization: OAuth the-session-uuid
Body
{ "reconnectVirtualRouter": {}, "systemTags": [], "userTags": [] }
Note: In the preceding sample, both systemTags and userTags are optional. These two fields can be included in the body structure.
Curl Sample
curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth bd24a72b74a148e8b18ee2b2367534d6" \ -X PUT -d '{"reconnectVirtualRouter":{}}' \ http://localhost:8080/zstack/v1/vm-instances/appliances/virtual-routers/74f9bb00796c366a83a6201df9e26f43/actions
Request Parameters
Name Type Location Description Optional Value Starting Version
vmInstanceUuid String url The VM instance UUID. 0.6
systemTags List body Optional. The system tags. 0.6
userTags List body Optional. The user tags. 0.6

API Response

Sample Response
{ "inventory": { "managementNetworkUuid": "9a154450da784a418db5406a463d2235", "name": "Test-Router", "description": "this is a virtual router vm", "clusterUuid": "9b359b8de95d4d97a19d53bf4193993a", "imageUuid": "c7bbef849e5d47478ee1db445d55530b", "instanceOfferingUuid": "5437f63807864c37b4d3042ee28f2680"   } }
Name Type Description Starting Version
error ErrorCode The error code. If not null, the operation fails, or vice versa. For more information, see error. 0.6
inventory ApplianceVmInventory See inventory. 0.6
#error
Name Type Description Starting Version
code String The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. 0.6
description String The brief description of the error. 0.6
details String The details about the error. 0.6
elaboration String The reserved field. Default value: null. 0.6
opaque LinkedHashMap The reserved field. Default value: null. 0.6
cause ErrorCode The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. 0.6
#inventory
Name Type Description Starting Version
applianceVmType String 0.6
managementNetworkUuid String 0.6
defaultRouteL3NetworkUuid String 0.6
status String 0.6
agentPort Integer 0.6
uuid String The resource UUID. 0.6
name String The resource name. 0.6
description String The detailed description of the resource. 0.6
zoneUuid String The zone UUID. 0.6
clusterUuid String The cluster UUID. 0.6
imageUuid String The image UUID. 0.6
hostUuid String The host UUID. 0.6
lastHostUuid String 0.6
instanceOfferingUuid String The instance offering UUID. 0.6
rootVolumeUuid String The root volume UUID. 0.6
platform String 0.6
defaultL3NetworkUuid String 0.6
type String 0.6
hypervisorType String 0.6
memorySize Long 0.6
cpuNum Integer 0.6
cpuSpeed Long 0.6
allocatorStrategy String 0.6
createDate Timestamp The creation date. 0.6
lastOpDate Timestamp The last operation date. 0.6
state String 0.6
vmNics List See vmNics. 0.6
allVolumes List See allVolumes. 0.6
#vmNics
Name Type Description Starting Version
uuid String The resource UUID. 0.6
vmInstanceUuid String The VM instance UUID. 0.6
l3NetworkUuid String The L3 network UUID. 0.6
ip String 0.6
mac String 0.6
netmask String 0.6
gateway String 0.6
metaData String 0.6
deviceId Integer 0.6
createDate Timestamp The creation date. 0.6
lastOpDate Timestamp The last operation date. 0.6
#allVolumes
Name Type Description Starting Version
uuid String The resource UUID. 0.6
name String The resource name. 0.6
description String The detailed description of the resource. 0.6
primaryStorageUuid String The primary storage UUID. 0.6
vmInstanceUuid String The VM instance UUID. 0.6
diskOfferingUuid String The disk offering UUID. 0.6
rootImageUuid String 0.6
installPath String 0.6
type String 0.6
format String 0.6
size Long 0.6
actualSize Long 0.6
deviceId Integer 0.6
state String 0.6
status String 0.6
createDate Timestamp The creation date. 0.6
lastOpDate Timestamp The last operation date. 0.6
isShareable Boolean 0.6

SDK Sample

Java SDK
ReconnectVirtualRouterAction action = new ReconnectVirtualRouterAction(); action.vmInstanceUuid = "3b20e87b87b442518efff8744c2cfde8"; action.sessionId = "ce03736cdddf4c49bce35d8e55e189c7"; ReconnectVirtualRouterAction.Result res = action.call();
Python SDK
ReconnectVirtualRouterAction action = ReconnectVirtualRouterAction() action.vmInstanceUuid = "ae937aa909594b1bb2e36359cd7dbc5b" action.sessionId = "4434d7282a7d4940bb0695c0d252bfae" ReconnectVirtualRouterAction.Result res = action.call()

QueryVirtualRouterVm

API Request

URLs
GET zstack/v1/vm-instances/appliances/virtual-routers GET zstack/v1/vm-instances/appliances/virtual-routers/{uuid}
Headers
Authorization: OAuth the-session-uuid
Curl Sample
curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth 823cd67ecc7c4e6fa25efbc7f9b5130b" \ -X GET http://localhost:8080/zstack/v1/vm-instances/appliances/virtual-routers?q=name=Test-Router
curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth 5b8a868c89ef434086caeb6ade4613bf" \ -X GET http://localhost:8080/zstack/v1/vm-instances/appliances/virtual-routers/a1f8c5edc13743d79ec8c9d912d1c280

Queryable Fields

You can check all queryable fields and resource names that can be queried across tables by using zstack-cli, entering QueryVirtualRouterVm, and pressing the Tab key.

API Response

Sample Response
{ "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": "/zstack_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"         }       ]     }   ] }
Name Type Description Starting Version
error ErrorCode The error code. If not null, the operation fails, or vice versa. For more information, see error. 0.6
inventories List See inventories. 0.6
#error
Name Type Description Starting Version
code String The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. 0.6
description String The brief description of the error. 0.6
details String The details about the error. 0.6
elaboration String The reserved field. Default value: null. 0.6
opaque LinkedHashMap The reserved field. Default value: null. 0.6
cause ErrorCode The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. 0.6
#inventories
Name Type Description Starting Version
applianceVmType String 0.6
managementNetworkUuid String 0.6
defaultRouteL3NetworkUuid String 0.6
status String 0.6
agentPort Integer 0.6
uuid String The resource UUID. 0.6
name String The resource name. 0.6
description String The detailed description of the resource. 0.6
zoneUuid String The zone UUID. 0.6
clusterUuid String The cluster UUID. 0.6
imageUuid String The image UUID. 0.6
hostUuid String The host UUID. 0.6
lastHostUuid String 0.6
instanceOfferingUuid String The instance offering UUID. 0.6
rootVolumeUuid String The root volume UUID. 0.6
platform String 0.6
defaultL3NetworkUuid String 0.6
type String 0.6
hypervisorType String 0.6
memorySize Long 0.6
cpuNum Integer 0.6
cpuSpeed Long 0.6
allocatorStrategy String 0.6
createDate Timestamp The creation date. 0.6
lastOpDate Timestamp The last operation date. 0.6
state String 0.6
vmNics List See vmNics. 0.6
allVolumes List See allVolumes. 0.6
#vmNics
Name Type Description Starting Version
uuid String The resource UUID. 0.6
vmInstanceUuid String The VM instance UUID. 0.6
l3NetworkUuid String The L3 network UUID. 0.6
ip String 0.6
mac String 0.6
netmask String 0.6
gateway String 0.6
metaData String 0.6
deviceId Integer 0.6
createDate Timestamp The creation date. 0.6
lastOpDate Timestamp The last operation date. 0.6
#allVolumes
Name Type Description Starting Version
uuid String The resource UUID. 0.6
name String The resource name. 0.6
description String The detailed description of the resource. 0.6
primaryStorageUuid String The primary storage UUID. 0.6
vmInstanceUuid String The VM instance UUID. 0.6
diskOfferingUuid String The disk offering UUID. 0.6
rootImageUuid String 0.6
installPath String 0.6
type String 0.6
format String 0.6
size Long 0.6
actualSize Long 0.6
deviceId Integer 0.6
state String 0.6
status String 0.6
createDate Timestamp The creation date. 0.6
lastOpDate Timestamp The last operation date. 0.6
isShareable Boolean 0.6

SDK Sample

Java SDK
QueryVirtualRouterVmAction action = new QueryVirtualRouterVmAction(); action.conditions = asList("name=Test-Router"); action.sessionId = "f25578538ecf4a55b98d51e5b8788adb"; QueryVirtualRouterVmAction.Result res = action.call();
Python SDK
QueryVirtualRouterVmAction action = QueryVirtualRouterVmAction() action.conditions = ["name=Test-Router"] action.sessionId = "d1cd40ad61f149689bb358c997377d4a" QueryVirtualRouterVmAction.Result res = action.call()

QueryApplianceVm

API Request

URLs
GET zstack/v1/vm-instances/appliances GET zstack/v1/vm-instances/appliances/{uuid}
Headers
Authorization: OAuth the-session-uuid
Curl Sample
curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth fee14fed21eb4535bcd2fd6a11fa9dcd" \ -X GET http://localhost:8080/zstack/v1/vm-instances/appliances?q=uuid=59b2f0ff7d3e49faab66fdb4bdfee249
curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth f11e69b5788b458e8149425132902365" \ -X GET http://localhost:8080/zstack/v1/vm-instances/appliances/5eaf0998a54345e5bb25bfdad34b2b31

Queryable Fields

You can check all queryable fields and resource names that can be queried across tables by using zstack-cli, entering QueryApplianceVm, and pressing the Tab key.

API Response

Sample Response
{ "inventories": [     { "uuid": "f71a399a79794ab8a41e26a601ac7387", "name": "Test-VM", "description": "Appliance VM", "zoneUuid": "4cf173a14e67440c9349c1e236a56c37", "clusterUuid": "07412e72791c474fa240b75da1b210c5", "imageUuid": "7bc33ed9760f424a9b9ff21fc0bbb48e", "hostUuid": "0cbed62c52bc407e994c966f246363bd", "lastHostUuid": "08921382c4f44705bae7cba6414c811d", "instanceOfferingUuid": "e056c84995cb4d68ac78dbcc30af3f4f", "rootVolumeUuid": "2557a6f997ee457fad526e179a76e8c0", "platform": "Linux", "defaultL3NetworkUuid": "748fc87b7fcb456cbea47432e52b377d", "type": "UserVm", "hypervisorType": "KVM", "memorySize": 8.589934592E9, "cpuNum": 1.0, "allocatorStrategy": "LastHostPreferredAllocatorStrategy", "createDate": "Jun 7, 2017 9:20:39 PM", "lastOpDate": "Jun 7, 2017 9:20:39 PM", "state": "Running", "vmNics": [         { "uuid": "d2dfc67ddf28431bb64cc90fe0e113f6", "vmInstanceUuid": "f71a399a79794ab8a41e26a601ac7387", "usedIpUuid": "f654374b78534f5fb9b75873084932a3", "l3NetworkUuid": "748fc87b7fcb456cbea47432e52b377d", "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:20:39 PM", "lastOpDate": "Jun 7, 2017 9:20:39 PM"         }       ], "allVolumes": [         { "uuid": "2557a6f997ee457fad526e179a76e8c0", "name": "Root-Volume-For-VM-f71a399a79794ab8a41e26a601ac7387", "primaryStorageUuid": "d00057b39df9494bbaf00d047dd04825", "vmInstanceUuid": "f71a399a79794ab8a41e26a601ac7387", "diskOfferingUuid": "20346d1b6643492fbc4da8d6baf4b6d2", "rootImageUuid": "7bc33ed9760f424a9b9ff21fc0bbb48e", "installPath": "/zstack_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-2557a6f997ee457fad526e179a76e8c0/2557a6f997ee457fad526e179a76e8c0.qcow2", "type": "Root", "format": "qcow2", "size": 1.073741824E11, "actualSize": 2.147483648E10, "deviceId": 0.0, "state": "Enabled", "status": "Ready", "createDate": "Jun 7, 2017 9:20:39 PM", "lastOpDate": "Jun 7, 2017 9:20:39 PM"         }       ]     }   ] }
Name Type Description Starting Version
error ErrorCode The error code. If not null, the operation fails, or vice versa. For more information, see error. 0.6
inventories List See inventories. 0.6
#error
Name Type Description Starting Version
code String The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. 0.6
description String The brief description of the error. 0.6
details String The details about the error. 0.6
elaboration String The reserved field. Default value: null. 0.6
opaque LinkedHashMap The reserved field. Default value: null. 0.6
cause ErrorCode The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. 0.6
#inventories
Name Type Description Starting Version
applianceVmType String 0.6
managementNetworkUuid String 0.6
defaultRouteL3NetworkUuid String 0.6
status String 0.6
agentPort Integer 0.6
uuid String The resource UUID. 0.6
name String The resource name. 0.6
description String The detailed description of the resource. 0.6
zoneUuid String The zone UUID. 0.6
clusterUuid String The cluster UUID. 0.6
imageUuid String The image UUID. 0.6
hostUuid String The host UUID. 0.6
lastHostUuid String 0.6
instanceOfferingUuid String The instance offering UUID. 0.6
rootVolumeUuid String The root volume UUID. 0.6
platform String 0.6
defaultL3NetworkUuid String 0.6
type String 0.6
hypervisorType String 0.6
memorySize Long 0.6
cpuNum Integer 0.6
cpuSpeed Long 0.6
allocatorStrategy String 0.6
createDate Timestamp The creation date. 0.6
lastOpDate Timestamp The last operation date. 0.6
state String 0.6
vmNics List See vmNics. 0.6
allVolumes List See allVolumes. 0.6
#vmNics
Name Type Description Starting Version
uuid String The resource UUID. 0.6
vmInstanceUuid String The VM instance UUID. 0.6
l3NetworkUuid String The L3 network UUID. 0.6
ip String 0.6
mac String 0.6
netmask String 0.6
gateway String 0.6
metaData String 0.6
deviceId Integer 0.6
createDate Timestamp The creation date. 0.6
lastOpDate Timestamp The last operation date. 0.6
#allVolumes
Name Type Description Starting Version
uuid String The resource UUID. 0.6
name String The resource name. 0.6
description String The detailed description of the resource. 0.6
primaryStorageUuid String The primary storage UUID. 0.6
vmInstanceUuid String The VM instance UUID. 0.6
diskOfferingUuid String The disk offering UUID. 0.6
rootImageUuid String 0.6
installPath String 0.6
type String 0.6
format String 0.6
size Long 0.6
actualSize Long 0.6
deviceId Integer 0.6
state String 0.6
status String 0.6
createDate Timestamp The creation date. 0.6
lastOpDate Timestamp The last operation date. 0.6
isShareable Boolean 0.6

SDK Sample

Java SDK
QueryApplianceVmAction action = new QueryApplianceVmAction(); action.conditions = asList("uuid=691c9a2eb7964cdd8cfad52a4acece7b"); action.sessionId = "9fec03d462184d6b9a87d314c00597ed"; QueryApplianceVmAction.Result res = action.call();
Python SDK
QueryApplianceVmAction action = QueryApplianceVmAction() action.conditions = ["uuid=0c17514849ac49809d6e6047fc4b4978"] action.sessionId = "485840ed54bc40cc9e47feabd0475ae7" QueryApplianceVmAction.Result res = action.call()















Products

Solutions

Help & Support

Contact Us

© 2023, Shanghai Yunzhou Information and Technology Ltd (云轴科技). All Rights Reserved.

Back to Top

Download

Already filled the basic info?Click here.

Enter at least 2 characters.
Invalid mobile number.
Enter at least 4 characters.
Invalid email address.
Wrong code. Try again. Send Code Resend Code (60s)

An email with a verification code will be sent to you. Make sure the address you provided is valid and correct.

Download

Not filled the basic info yet? Click here.

Invalid email address or mobile number.

Email Us

contact@zstack.io
ZStack Training and Certification
Enter at least 2 characters.
Invalid mobile number.
Enter at least 4 characters.
Invalid email address.
Wrong code. Try again. Send Code Resend Code (60s)

Email Us

contact@zstack.io
Request Trial
Enter at least 2 characters.
Invalid mobile number.
Enter at least 4 characters.
Invalid email address.
Wrong code. Try again. Send Code Resend Code (60s)

Email Us

contact@zstack.io

The download link is sent to your email address.

If you don't see it, check your spam folder, subscription folder, or AD folder. After receiving the email, click the URL to download the documentation.

The download link is sent to your email address.

If you don't see it, check your spam folder, subscription folder, or AD folder.
Or click on the URL below. (For Internet Explorer, right-click the URL and save it.)

Thank you for using ZStack products and services.

Submit successfully.

We'll connect soon.

Thank you for using ZStack products and services.