ZStack ZSphere Documentation
All Version
All
ZStack ZSphere Documentation>ZSphere API Reference(v5.0.0)>Compute Management>Image Storage Related Interfaces
Get PDF

Delete Backup Storage(DeleteBackupStorage)

API Request

URLs
DELETE zstack/v1/backup-storage/{uuid}?deleteMode={deleteMode}
Headers
Authorization: OAuth the-session-uuid
Curl Example
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
Parameter List
Name Type Location Description Allowed Values Starting Version
uuid String url UUID of the resource, uniquely identifies the resource 0.6
deleteMode (Optional) String body Delete mode (Permissive or Enforcing, default is Permissive) 0.6
systemTags (Optional) List body System tags 0.6
userTags (Optional) List body User tags 0.6

API Response

On success, this API returns an empty JSON structure {}. On error, the returned JSON structure contains 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 Examples

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()

Query Backup Storage (QueryBackupStorage)

API Request

URLs
GET zstack/v1/backup-storage GET zstack/v1/backup-storage/{uuid}
Headers
Authorization: OAuth the-session-uuid
Curl Example
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

Run the CLI command tool, enter QueryBackupStorage and press Tab to view all queryable fields and resource names that support cross-table queries.

API Response

Response Example (Standalone Image Storage)
{     "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 }
Response Example (Distributed Image Storage)
{     "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 Error code. If not null, the operation failed. This field is null when the operation succeeds. See error 0.6
inventories List See inventories 0.6
#error
Name Type Description Starting Version
code String Error code number, globally unique identifier, 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, defaults to null 0.6
opaque LinkedHashMap Reserved field, defaults to null 0.6
cause ErrorCode Root cause. The source error that triggered the current error. This field is null if there is no original error 0.6
#inventories
Name Type Description Starting Version
uuid String Resource UUID, uniquely identifies the resource 0.6
name String Resource name 0.6
url String 0.6
description String 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 Creation time 0.6
lastOpDate Timestamp Last modification time 0.6
attachedZoneUuids List 0.6

SDK Examples

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()














































Archives

Download Document Archives

Download

Already filled the basic info?Click here.

Enter at least 2 characters.
Cannot be empty.
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.

同意 不同意

I have read and concur with the Site Terms 、 Privacy Policy 、 Rules and Conventions on User Management of ZStack Cloud

Download

Not filled the basic info yet? Click here.

Invalid email address or mobile number.
同意 不同意

I have read and concur with the Site Terms 、 Privacy Policy 、 Rules and Conventions on User Management of ZStack Cloud

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)

同意 不同意

I have read and concur with the Site Terms 、 Privacy Policy 、 Rules and Conventions on User Management of ZStack Cloud

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)

同意 不同意

I have read and concur with the Site Terms 、 Privacy Policy 、 Rules and Conventions on User Management of ZStack Cloud

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.