功能介紹
對(duì)存儲(chǔ)庫(kù)執(zhí)行備份，生成備份還原點(diǎn)
調(diào)試
您可以在API Explorer中調(diào)試該接口，支持自動(dòng)認(rèn)證鑒權(quán)。API Explorer可以自動(dòng)生成SDK代碼示例，并提供SDK代碼示例調(diào)試功能。
URI
POST /v3/{project_id}/checkpoints
|
參數(shù) |
是否必選 |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
項(xiàng)目ID |
請(qǐng)求參數(shù)
|
參數(shù) |
是否必選 |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用戶Token。 通過(guò)調(diào)用 IAM 服務(wù)獲取用戶Token接口獲取（響應(yīng)消息頭中X-Subject-Token的值）。 |
|
參數(shù) |
是否必選 |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|---|
|
checkpoint |
是 |
存儲(chǔ)庫(kù)執(zhí)行備份參數(shù) |
|
參數(shù) |
是否必選 |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|---|
|
auto_trigger |
否 |
Boolean |
是否自動(dòng)觸發(fā),true:自動(dòng)觸發(fā)，false：非自動(dòng)觸發(fā)。 缺省值：false |
|
description |
否 |
String |
備份描述 最小長(zhǎng)度：0 最大長(zhǎng)度：255 |
|
incremental |
否 |
Boolean |
是否增量備份，true:增量備份，false：非增量備份。 缺省值：true |
|
name |
否 |
String |
備份名稱(chēng)，只能由數(shù)字、中文、英文大小寫(xiě)字母，以及下劃線"_"和中橫線 "-" 字符構(gòu)成。 最小長(zhǎng)度：1 最大長(zhǎng)度：64 |
|
resources |
否 |
Array of strings |
待備份的資源id列表:uuid |
|
resource_details |
否 |
資源詳情 數(shù)組長(zhǎng)度：0 - 256 |
|
參數(shù) |
是否必選 |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|---|
|
extra_info |
否 |
資源附加信息 |
|
|
id |
是 |
String |
待備份資源id |
|
name |
否 |
String |
待備份資源名稱(chēng)，長(zhǎng)度限制：0-255 最小長(zhǎng)度：0 最大長(zhǎng)度：255 |
|
type |
是 |
String |
待備份資源的類(lèi)型: OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo, OS:: Workspace ::DesktopV2 |
響應(yīng)參數(shù)
狀態(tài)碼： 200
|
參數(shù) |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|
|
created_at |
String |
創(chuàng)建時(shí)間，例如:"2020-02-05T10:38:34.209782" |
|
id |
String |
還原點(diǎn)ID |
|
project_id |
String |
項(xiàng)目ID |
|
status |
String |
狀態(tài):available,deleting,protecting,deleted,error-deleting,error 枚舉值：
|
|
vault |
存儲(chǔ)庫(kù)信息 |
|
|
extra_info |
擴(kuò)展信息 |
|
參數(shù) |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|
|
id |
String |
存儲(chǔ)庫(kù)id |
|
name |
String |
存儲(chǔ)庫(kù)名稱(chēng) |
|
resources |
備份對(duì)象 |
|
|
skipped_resources |
備份時(shí)跳過(guò)的資源列表 |
|
參數(shù) |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|
|
extra_info |
String |
資源附加信息 |
|
id |
String |
待備份資源id |
|
name |
String |
待備份資源名稱(chēng) |
|
protect_status |
String |
保護(hù)狀態(tài)。available（可用），error（錯(cuò)誤），protecting（備份中），restoring（恢復(fù)中），removing（刪除中）。 枚舉值：
|
|
resource_size |
String |
資源已分配容量,單位為GB |
|
type |
String |
待備份資源的類(lèi)型: OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo, OS::Workspace::DesktopV2 |
|
backup_size |
String |
副本大小 |
|
backup_count |
String |
副本數(shù)量 |
|
參數(shù) |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|
|
id |
String |
資源ID |
|
type |
String |
資源類(lèi)型 |
|
name |
String |
資源名稱(chēng) |
|
code |
String |
請(qǐng)參見(jiàn)錯(cuò)誤碼。 |
|
reason |
String |
跳過(guò)原因，例如：該資源正在備份中。 |
請(qǐng)求示例
執(zhí)行存儲(chǔ)庫(kù)資源自動(dòng)備份，生成備份還原點(diǎn)。
POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/checkpoints
{
"checkpoint" : {
"parameters" : {
"auto_trigger" : true,
"description" : "backup_description",
"incremental" : true,
"name" : "backup_name",
"resources" : [ "94eba8b2-acc9-4d82-badc-127144cc5526" ]
},
"vault_id" : "3b5816b5-f29c-4172-9d9a-76c719a659ce"
}
}
響應(yīng)示例
狀態(tài)碼： 200
OK
{
"checkpoint" : {
"status" : "protecting",
"created_at" : "2019-05-10T07:59:12.733403",
"vault" : {
"skipped_resources" : [ ],
"id" : "3b5816b5-f29c-4172-9d9a-76c719a659ce",
"resources" : [ {
"name" : "ecs-1f0f-0002",
"resource_size" : "40",
"protect_status" : "available",
"type" : "OS::Nova::Server",
"id" : "94eba8b2-acc9-4d82-badc-127144cc5526",
"extra_info" : null
} ],
"name" : "vault-be94"
},
"project_id" : "4229d7a45436489f8c3dc2b1d35d4987",
"id" : "8b0851a8-adf3-4f4c-a914-dead08bf9664",
"extra_info" : {
"retention_duration" : -1,
"name" : "backup_name",
"description" : "backup_description"
}
}
}
狀態(tài)碼
|
狀態(tài)碼 |
描述 |
|---|---|
|
200 |
OK |
錯(cuò)誤碼
請(qǐng)參見(jiàn)錯(cuò)誤碼。
