镜像存储相关接口

删除镜像存储(DeleteBackupStorage)

API请求

URLs

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

Headers

Authorization: OAuth the-session-uuid

Curl示例

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

参数列表

名字	类型	位置	描述	起始版本
uuid	String	url	资源的UUID，唯一标示该资源	0.6
deleteMode (可选)	String	body	删除模式(Permissive 或者 Enforcing, 默认 Permissive)	0.6
systemTags (可选)	List	body	系统标签	0.6
userTags (可选)	List	body	用户标签	0.6

API返回

该API成功时返回一个空的JSON结构{}，出错时返回的JSON结构包含一个error字段，例如：

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

SDK示例

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请求

URLs

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

Headers

Authorization: OAuth the-session-uuid

Curl示例

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

可查询字段

运行CLI命令行工具，输入QueryBackupStorage并按Tab键查看所有可查询字段以及可跨表查询的资源名。

API返回

返回示例（单机镜像仓库）

{     "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 }

返回示例（分布式镜像仓库）

{     "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 }

名字	类型	描述	起始版本
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	0.6
inventories	List	详情参考inventories	0.6

#error

名字	类型	描述	起始版本
code	String	错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001	0.6
description	String	错误的概要描述	0.6
details	String	错误的详细信息	0.6
elaboration	String	保留字段，默认为null	0.6
opaque	LinkedHashMap	保留字段，默认为null	0.6
cause	ErrorCode	根错误，引发当前错误的源错误，若无原错误，该字段为null	0.6

#inventories

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	0.6
name	String	资源名称	0.6
url	String		0.6
description	String	资源的详细描述	0.6
totalCapacity	Long		0.6
availableCapacity	Long		0.6
type	String		0.6
state	String		0.6
status	String		0.6
createDate	Timestamp	创建时间	0.6
lastOpDate	Timestamp	最后一次修改时间	0.6
attachedZoneUuids	List		0.6

SDK示例

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

升级提醒

若您选择升级至4.0.0及之后版本，请注意以下功能调整：

1. 云路由器全面升级为VPC路由器，云路由网络全面升级为VPC网络，不再单独设云路由器页面。升级全程无感知，相关业务不受任何影响。

2. 企业管理账号体系取代用户组与用户，不再单独设用户/用户组页面，不可再使用用户/用户组账号登录云平台。升级前，请先将“用户组与用户”纳管的账号数据妥善迁移至“企业管理”纳管，再执行升级操作。注意：对于admin创建并具备admin权限的用户账号同步取消，如有需要，可使用企业管理账号体系中的平台管理员实现相同功能。

3. 调整AD/LDAP与账户的对接管理方式，统一由企业管理纳管，不再单独设AD/LDAP页面。升级前，请先将“账户”对接纳管的AD/LDAP账号数据妥善迁移至“企业管理”纳管，再执行升级操作。

如对上述升级提醒有任何疑问或需要升级帮助，请联系ZStack官方技术支持