API Reference | ZStack ZSphere · ZVF | ZStack Resource Center

API Request

URLs

GET zstack/v1/vmInstance/device/address/archive
GET zstack/v1/vmInstance/device/address/archive/{uuid}

Headers

Authorization: OAuth the-session-uuid

Curl Example

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/vmInstance/device/address/archive?q=uuid=afba7c48d2cc3f4d9ea410a477e9e46b

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/vmInstance/device/address/archive/4223731f73ed3307a0a64abe83bfbcac

Queryable Fields

Run the CLI command tool, enter QueryVmInstanceDeviceAddressArchive and press Tab to view all queryable fields and resource names that can be queried across tables.

API Response

Response Example

{
  "inventories": [
    {
      "id": 1,
      "resourceUuid": "ae77498fb74438369a9c2ae9083d609b",
      "deviceAddress": "{\"bus\":\"00\",\"domain\":\"0000\",\"slot\":\"0d\",\"function\":\"0\"}",
      "addressGroupUuid": "b91ec524d04a3f34b080d769c4696b6d",
      "metadata": "Metadata",
      "metadataClass": "org.zstack.header.vm.devices.VmInstanceDeviceAddressArchiveInventory",
      "createDate": "Nov 14, 2017 2:20:57 PM",
      "lastOpDate": "Nov 14, 2017 2:20:57 PM"
    }
  ]
}

Name	Type	Description	Starting Version
success	boolean	Whether the operation succeeded.	4.4.24
inventories	List	For details, see inventories	4.4.24
error	ErrorCode	Error code. If not null, the operation failed. When the operation is successful, this field is null. For details, see error	4.4.24

#inventories

Name	Type	Description	Starting Version
id	long	The resource ID.	4.4.24
resourceUuid	String	Resource UUID	4.4.24
vmInstanceUuid	String	Virtual Machine UUID	4.4.24
deviceAddress	String	The device address.	4.4.24
addressGroupUuid	String	The address group UUID.	4.4.24
metadata	String	The metadata.	4.4.24
metadataClass	String	The metadata class.	4.4.24
createDate	Timestamp	Create time	4.4.24
lastOpDate	Timestamp	Last modification time	4.4.24

#error

Name	Type	Description	Starting Version
code	String	Error code number, globally unique identifier of the error, for example SYS.1000, HOST.1001	0.6
description	String	Brief description of the error	0.6
details	String	Detailed error information	0.6
elaboration	String	Reserved field, default is null	0.6
opaque	LinkedHashMap	Reserved field, default is null	0.6
cause	ErrorCode	Root cause: the source error that triggered the current error. If there is no original error, this field is null	0.6

SDK Examples

Java SDK

QueryVmInstanceDeviceAddressArchiveAction action = new QueryVmInstanceDeviceAddressArchiveAction();
action.conditions = asList("uuid=7091344656733ce2ab5ba32eae02b55f");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryVmInstanceDeviceAddressArchiveAction.Result res = action.call();

Python SDK

QueryVmInstanceDeviceAddressArchiveAction action = QueryVmInstanceDeviceAddressArchiveAction()
action.conditions = ["uuid=3d9b045230bd3098a6e197bf06e147da"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryVmInstanceDeviceAddressArchiveAction.Result res = action.call()