Primary Storage Operations

DeletePrimaryStorage

API Request

URLs

DELETE zstack/v1/primary-storage/{uuid}?deleteMode={deleteMode}

Headers

Authorization: OAuth the-session-uuid

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth af6279db8d5d4434afe789fdb214fe86" \ -X DELETE http://localhost:8080/zstack/v1/primary-storage/84ecb184e2f649ac9300f804dfd9f43e?deleteMode=Permissive

Request Parameters

Name	Type	Location	Description	Starting Version
uuid	String	url	The primary storage UUID.	0.6
deleteMode	String	body	Optional. The delete mode. Options: Permissive \| Enforcing. Default mode: Permissive.	0.6
systemTags	List	body	Optional. The system tags.	0.6
userTags	List	body	Optional. The user tags.	0.6

API Response

When the API succeeded, an empty JSON structure {} is returned. When the API failed, the returned JSON structure includes an error field. For example,

{ "error": { "code": "SYS.1001", "description": "A message or a operation timeout", "details": "Create VM on KVM timeout after 300s"     } }

SDK Sample

Java SDK

DeletePrimaryStorageAction action = new DeletePrimaryStorageAction(); action.uuid = "c471a57db90945129303e69cf731fee3"; action.deleteMode = "Permissive"; action.sessionId = "34041f0d587e4ce1827dd88f34a0a94b"; DeletePrimaryStorageAction.Result res = action.call();

Python SDK

DeletePrimaryStorageAction action = DeletePrimaryStorageAction() action.uuid = "309a9da1c0884e679dd7f96502130ce3" action.deleteMode = "Permissive" action.sessionId = "0aa8b461719c45eea867c0be49565489" DeletePrimaryStorageAction.Result res = action.call()

QueryPrimaryStorage

API Request

URLs

GET zstack/v1/primary-storage

Headers

Authorization: OAuth the-session-uuid

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth f889c6a0220c4b34b3007f72bd04e839" \ -X GET http://localhost:8080/zstack/v1/primary-storage?q=uuid=2160b1e46b0a422fbc9ce6e4a7de1023

Queryable Fields

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

API Response

Sample Response

{ "inventories": [     { "name": "PS1", "url": "/zstack_ps", "type": "LocalStorage", "state": "Enabled", "status": "Connected", "attachedClusterUuids": [ "efbdb96e4f9c457eacf11dcb19923af9"       ]     }   ] }

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 detailed description of the resource.	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
uuid	String	The resource UUID.	0.6
zoneUuid	String	The zone UUID.	0.6
name	String	The resource name.	0.6
url	String		0.6
description	String	The detailed description of the resource.	0.6
totalCapacity	Long		0.6
availableCapacity	Long		0.6
totalPhysicalCapacity	Long		0.6
availablePhysicalCapacity	Long		0.6
systemUsedCapacity	Long		0.6
type	String		0.6
state	String		0.6
status	String		0.6
mountPath	String		0.6
createDate	Timestamp	The creation date.	0.6
lastOpDate	Timestamp	The last operation date.	0.6
attachedClusterUuids	List		0.6

SDK Sample

Java SDK

QueryPrimaryStorageAction action = new QueryPrimaryStorageAction(); action.conditions = asList("uuid=56235f6bf5c24513bce99d4ec824c63f"); action.sessionId = "16f5568fa9aa48e79b3a3ed579787fd0"; QueryPrimaryStorageAction.Result res = action.call();

Python SDK

QueryPrimaryStorageAction action = QueryPrimaryStorageAction() action.conditions = ["uuid=52f2459af9ce4c35a0c7de9c98aaebb0"] action.sessionId = "ade5be353d114f948f976ae43d397815" QueryPrimaryStorageAction.Result res = action.call()

AttachPrimaryStorageToCluster

API Request

URLs

POST zstack/v1/clusters/{clusterUuid}/primary-storage/{primaryStorageUuid}

Headers

Authorization: OAuth the-session-uuid

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X POST http://localhost:8080/zstack/v1/clusters/06fa0d99fd9733409ea9dcb29e070fcf/primary-storage/e6df72f4eaaa324fb650cb7165bff218

Request Parameters

Name	Type	Location	Description	Starting Version
clusterUuid	String	url	The cluster UUID.	0.6
primaryStorageUuid	String	url	The primary storage 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": { "name": "PS1", "url": "/zstack_ps", "type": "LocalStorage", "state": "Enabled", "status": "Connected", "attachedClusterUuids": [ "f0262ff5aeb54cd19e0a33bfaa61f5a4"     ]   } }

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	PrimaryStorageInventory	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
uuid	String	The resource UUID.	0.6
zoneUuid	String	The zone UUID.	0.6
name	String	The resource name.	0.6
url	String		0.6
description	String	The detailed description of the resource.	0.6
totalCapacity	Long		0.6
availableCapacity	Long		0.6
totalPhysicalCapacity	Long		0.6
availablePhysicalCapacity	Long		0.6
systemUsedCapacity	Long		0.6
type	String		0.6
state	String		0.6
status	String		0.6
mountPath	String		0.6
createDate	Timestamp	The creation date.	0.6
lastOpDate	Timestamp	The last operation date.	0.6
attachedClusterUuids	List		0.6

SDK Sample

Java SDK

AttachPrimaryStorageToClusterAction action = new AttachPrimaryStorageToClusterAction(); action.clusterUuid = "473e453a99844ea2a3b65aa637d33841"; action.primaryStorageUuid = "ffd9b14c1c3442f2bde3209cbe9cc195"; action.sessionId = "97c7848a46b44ba89f348f434b5f2288"; AttachPrimaryStorageToClusterAction.Result res = action.call();

Python SDK

AttachPrimaryStorageToClusterAction action = AttachPrimaryStorageToClusterAction() action.clusterUuid = "cfae196b0d514f9fbc6ecd5360cb6ccf" action.primaryStorageUuid = "c122244cd9ab48fa80f61e781e98bb03" action.sessionId = "c5b2cc8440fc4a6299c5f96a37d38a7f" AttachPrimaryStorageToClusterAction.Result res = action.call()