创建数据库备份(CreateDatabaseBackup)
API请求
URLs
POST zstack/v1/database-backups
Headers
Authorization: OAuth the-session-uuid
Body
{
"params": {
"name": "zstack-db",
"backupStorageUuid": "676c5945223647698fcf4da2fa46d1dd"
},
"systemTags": [],
"userTags": []
}
Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"name":"zstack-db","backupStorageUuid":"0c0f5fc523d8420a97a9be367f112b4a"}}' http://localhost:8080/zstack/v1/database-backups
参数列表
名字 | 类型 | 位置 | 描述 | 可选值 | 起始版本 |
---|---|---|---|---|---|
name | String | body(包含在params结构中) | 资源名称 | 3.0.0 | |
description | String | body(包含在params结构中) | 资源的详细描述 | 3.0.0 | |
backupStorageUuid | String | body(包含在params结构中) | 镜像存储UUID | 3.0.0 | |
resourceUuid (可选) | String | body(包含在params结构中) | 3.0.0 | ||
systemTags (可选) | List | body | 3.0.0 | ||
userTags (可选) | List | body | 3.0.0 |
API返回
返回示例
{
"inventory": {
"uuid": "7decf4a7cb7c41dabc57446df2784476",
"name": "zsdb",
"state": "Enabled",
"size": 1000.0,
"metadata": "{\"version\":\"3.0.0\"}",
"createDate": "Nov 14, 2017 10:20:57 PM",
"lastOpDate": "Nov 14, 2017 10:20:57 PM"
}
}
名字 | 类型 | 描述 | 起始版本 |
---|---|---|---|
error | ErrorCode | 错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error | 3.0.0 |
inventory | DatabaseBackupInventory | 详情参考inventory | 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 |
#inventory
名字 | 类型 | 描述 | 起始版本 |
---|---|---|---|
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
CreateDatabaseBackupAction action = new CreateDatabaseBackupAction();
action.name = "zstack-db";
action.backupStorageUuid = "35c0d1e417d84bf498be201091f39c49";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CreateDatabaseBackupAction.Result res = action.call();
Python
SDK
CreateDatabaseBackupAction action = CreateDatabaseBackupAction()
action.name = "zstack-db"
action.backupStorageUuid = "476870bf9c4241c8993340bd0703d0bf"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
CreateDatabaseBackupAction.Result res = action.call()