查询数据库备份(QueryDatabaseBackup)

API请求

URLs

GET zstack/v1/database-backups
GET zstack/v1/database-backups/{uuid}

Headers

Authorization: OAuth the-session-uuid

Curl示例

curl -H "Content-Type: application/json" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/database-backups?q=uuid=9f5010336a233d6ebbd82594a6d56e7c

curl -H "Content-Type: application/json" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/database-backups/296a7da913333dd992d89bf30d9304ed

可查询字段

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

API返回

返回示例

{
  "inventories": [
    {
      "uuid": "742a7c7d4a4f3a01b206632a40ac414f",
      "name": "db-backup",
      "description": "db-backup",
      "size": 13107.0
    }
  ]
}


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

#error


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

#inventories


名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	3.0.0
name	String	资源名称	3.0.0
description	String	资源的详细描述	3.0.0
state	String		3.0.0
status	String		3.0.0
size	Long		3.0.0
metadata	String		3.0.0
createDate	Timestamp	创建时间	3.0.0
lastOpDate	Timestamp	最后一次修改时间	3.0.0
backupStorageRefs	List	详情参考backupStorageRefs	3.0.0

#backupStorageRefs


名字	类型	描述	起始版本
databaseBackupUuid	String		3.0.0
backupStorageUuid	String	镜像存储UUID	3.0.0
installPath	String		3.0.0
exportUrl	String		3.0.0
status	String		3.0.0
createDate	Timestamp	创建时间	3.0.0
lastOpDate	Timestamp	最后一次修改时间	3.0.0

SDK示例

Java SDK

QueryDatabaseBackupAction action = new QueryDatabaseBackupAction();
action.conditions = asList("uuid=74b420b3e877354e832a900915aab41a");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryDatabaseBackupAction.Result res = action.call();

Python SDK

QueryDatabaseBackupAction action = QueryDatabaseBackupAction()
action.conditions = ["uuid=b11af605703231b4a898bed3fb7d94c0"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryDatabaseBackupAction.Result res = action.call()