Backup Storage Operations

DeleteBackupStorage

API Request

URLs

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

Headers

Authorization: OAuth the-session-uuid

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth 3cb9fd3d9fad4f64b62086b1aeabf42a" \ -X DELETE http://localhost:8080/zstack/v1/backup-storage/12b157dc061a46739168b6e87bf2657f?deleteMode=Permissive

Request Parameters

Name	Type	Location	Description	Starting Version
uuid	String	url	The resource 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

DeleteBackupStorageAction action = new DeleteBackupStorageAction(); action.uuid = "1c8acbc2af8445a5b631350276787580"; action.deleteMode = "Permissive"; action.sessionId = "4caf9cc241604dbca3088779d6772dbe"; DeleteBackupStorageAction.Result res = action.call();

Python SDK

DeleteBackupStorageAction action = DeleteBackupStorageAction() action.uuid = "06473459fd474a26bb1d79e2edd004f3" action.deleteMode = "Permissive" action.sessionId = "a6fead8970fe45cfa6ba92e7dcf08d66" DeleteBackupStorageAction.Result res = action.call()

QueryBackupStorage

API Request

URLs

GET zstack/v1/backup-storage GET zstack/v1/backup-storage/{uuid}

Headers

Authorization: OAuth the-session-uuid

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth dce9c25b65254343b0f9a568a661f348" \ -X GET http://localhost:8080/zstack/v1/backup-storage?q=uuid=435e61f882cf431bb4ae48246489a988

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth fe9a6571fc9949e7a0d31d94fae9b87c" \ -X GET http://localhost:8080/zstack/v1/backup-storage/1ab3b836a88342e1bbc1b1a17d092f0f

Queryable Fields

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

API Response

Sample Response (ImageStore)

{     "inventories": [         {             "attachedZoneUuids": [                 "140ebc2fbdb74ae197323a69d432f25e"             ],             "availableCapacity": 4931431059456,             "createDate": "Apr 11, 2018 2:50:54 PM",             "description": "",             "hostname": "172.20.1.115",             "lastOpDate": "Dec 13, 2019 7:32:49 PM",             "name": "image-store",             "sshPort": 22,             "state": "Enabled",             "status": "Connected",             "totalCapacity": 9992857976832,             "type": "ImageStoreBackupStorage",             "url": "/zstack_imagestore",             "username": "root",             "uuid": "1ab3b836a88342e1bbc1b1a17d092f0f"         }     ],     "success": true }

Sample Response (Ceph)

{     "inventories": [         {             "attachedZoneUuids": [                 "195ae9157b9248e3889cc56cfd7d0f8d"             ],             "availableCapacity": 297500737536,             "createDate": "Dec 14, 2019 9:46:05 AM",             "description": "Test",             "fsid": "d53902bc-ff50-4d08-8769-9d83448478d3",             "lastOpDate": "Dec 14, 2019 11:30:40 AM",             "mons": [                 {                     "backupStorageUuid": "eed424abee694bcda5a5e414a61ea3d3",                     "createDate": "Dec 14, 2019 9:46:05 AM",                     "hostname": "172.24.249.174",                     "lastOpDate": "Dec 14, 2019 11:21:46 AM",                     "monAddr": "172.24.249.174",                     "monPort": 6789,                     "monUuid": "e6707015afc8405ba0b184ca7a318b63",                     "sshPassword": "password",                     "sshPort": 22,                     "sshUsername": "root",                     "status": "Connected"                 },                 {                     "backupStorageUuid": "eed424abee694bcda5a5e414a61ea3d3",                     "createDate": "Dec 14, 2019 9:46:05 AM",                     "hostname": "172.24.252.188",                     "lastOpDate": "Dec 14, 2019 11:21:45 AM",                     "monAddr": "172.24.252.188",                     "monPort": 6789,                     "monUuid": "d5e70424ddac4c03ab06466d600ef4ae",                     "sshPassword": "password",                     "sshPort": 22,                     "sshUsername": "root",                     "status": "Connected"                 },                 {                     "backupStorageUuid": "eed424abee694bcda5a5e414a61ea3d3",                     "createDate": "Dec 14, 2019 9:46:05 AM",                     "hostname": "172.24.247.108",                     "lastOpDate": "Dec 14, 2019 11:21:16 AM",                     "monAddr": "172.24.247.108",                     "monPort": 6789,                     "monUuid": "378826f5f690480983f39514e0b00f75",                     "sshPassword": "password",                     "sshPort": 22,                     "sshUsername": "root",                     "status": "Connected"                 }             ],             "name": "ceph-bs",             "poolAvailableCapacity": 99166913877,             "poolName": "bak-t-eed424abee694bcda5a5e414a61ea3d3",             "poolReplicatedSize": 3,             "poolUsedCapacity": 2787687082,             "state": "Enabled",             "status": "Connected",             "totalCapacity": 305863802880,             "type": "Ceph",             "url": "not used",             "uuid": "eed424abee694bcda5a5e414a61ea3d3"         }     ],     "success": true }

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
uuid	String	The resource 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
type	String		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
attachedZoneUuids	List		0.6

SDK Sample

Java SDK

QueryBackupStorageAction action = new QueryBackupStorageAction(); action.conditions = asList("uuid=b8e17834373747ae8b6555db80e74586"); action.sessionId = "f5d478c4facf42f4a3f16c8efbfd9628"; QueryBackupStorageAction.Result res = action.call();

Python SDK

QueryBackupStorageAction action = QueryBackupStorageAction() action.conditions = ["uuid=0359113913834277bc815b446a6eff25"] action.sessionId = "dc56b36c279f449ea2d430d2513a4cb0" QueryBackupStorageAction.Result res = action.call()

ReconnectBackupStorage

API Request

URLs

PUT zstack/v1/backup-storage/{uuid}/actions

Headers

Authorization: OAuth the-session-uuid

Body

{ "reconnectBackupStorage": {}, "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 b86c9016b4f24953a9edefb53ca0678c" \ -X PUT -d '{"reconnectBackupStorage":{}}' \ http://localhost:8080/zstack/v1/backup-storage/37ea58b550103d40b23420e870bd616f/actions

Request Parameters

Name	Type	Location	Description	Starting Version
uuid	String	url	The resource 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": "My Backup Storage", "description": "Public Backup Storage", "totalCapacity": 1.073741824E9, "availableCapacity": 9.68884224E8, "type": "Ceph", "state": "Enabled", "status": "Connected", "createDate": "Jun 7, 2017 9:20:21 PM", "lastOpDate": "Jun 7, 2017 9:20:21 PM", "attachedZoneUuids": [ "410e621653de4bab8fd44f81e74b9225"     ]   } }

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	BackupStorageInventory	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
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
type	String		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
attachedZoneUuids	List		0.6

SDK Sample

Java SDK

ReconnectBackupStorageAction action = new ReconnectBackupStorageAction(); action.uuid = "f68e2350598547198b72bd578d14b037"; action.sessionId = "dcc8725e00f4437889104fe6ce942f96"; ReconnectBackupStorageAction.Result res = action.call();

Python SDK

ReconnectBackupStorageAction action = ReconnectBackupStorageAction() action.uuid = "2f2571f4864c46778544b500d006dfe7" action.sessionId = "a1c68d6ead48410ab9fd255d4c73f843" ReconnectBackupStorageAction.Result res = action.call()