功能介紹
查詢所有副本
調(diào)試
您可以在API Explorer中調(diào)試該接口，支持自動(dòng)認(rèn)證鑒權(quán)。API Explorer可以自動(dòng)生成SDK代碼示例，并提供SDK代碼示例調(diào)試功能。
URI
GET /v3/{project_id}/backups
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
項(xiàng)目ID |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
checkpoint_id |
否 |
String |
還原點(diǎn)ID |
|
dec |
否 |
Boolean |
專屬云 （專屬云場(chǎng)景使用，非專屬云場(chǎng)景不生效） |
|
end_time |
否 |
String |
備份產(chǎn)生時(shí)間范圍的結(jié)束時(shí)間，格式為%YYYY-%mm-%ddT%HH:%MM:%SSZ，例如2018-02-01T12:00:00Z |
|
enterprise_project_id |
否 |
String |
企業(yè)項(xiàng)目id或all_granted_eps，all_granted_eps表示查詢用戶有權(quán)限的所有企業(yè)項(xiàng)目id |
|
image_type |
否 |
String |
備份類型。取值為backup和replication。 |
|
incremental |
否 |
Boolean |
是否是增備 缺省值：false |
|
limit |
否 |
Integer |
每頁(yè)顯示的條目數(shù)量，正整數(shù) |
|
marker |
否 |
String |
上一次查詢最后一條的id |
|
member_status |
否 |
String |
共享狀態(tài) 枚舉值：
|
|
name |
否 |
String |
名稱 |
|
offset |
否 |
Integer |
偏移值，正整數(shù) |
|
own_type |
否 |
String |
持有類型，私有的private/共享的shared/全部all_granted，默認(rèn)只查詢private。 缺省值：private 枚舉值：
|
|
parent_id |
否 |
String |
父?jìng)浞軮D |
|
resource_az |
否 |
String |
支持按az來(lái)過(guò)濾 |
|
resource_id |
否 |
String |
資源ID |
|
resource_name |
否 |
String |
資源名稱 |
|
resource_type |
否 |
String |
資源類型: OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo, OS:: Workspace ::DesktopV2 |
|
show_replication |
否 |
Boolean |
是否返回復(fù)制記錄 缺省值：false |
|
sort |
否 |
String |
sort的內(nèi)容為一組由逗號(hào)分隔的屬性及可選排序方向組成，形如<key1>[:<direction>],<key2>[:<direction>],其中direction的取值為asc (升序) 或 desc (降序),如沒(méi)有傳入direction參數(shù)，默認(rèn)為降序，sort內(nèi)容的長(zhǎng)度限制為255個(gè)字符。key取值范圍:[created_at，updated_at，name，status，protected_at，id] |
|
start_time |
否 |
String |
備份產(chǎn)生時(shí)間范圍的開(kāi)始時(shí)間，格式為%YYYY-%mm-%ddT%HH:%MM:%SSZ，例如2018-02-01T12:00:00Z |
|
status |
否 |
String |
狀態(tài)。 調(diào)用API時(shí)，支持通過(guò)傳多個(gè)status值進(jìn)行過(guò)濾。例如：status=available&status=error 枚舉值：
|
|
used_percent |
否 |
String |
根據(jù)存儲(chǔ)庫(kù)使用率過(guò)濾備份，取值范圍 [1, 100]，含1和100。例如，used_percent=80，表示篩選所屬存儲(chǔ)庫(kù)使用率大于等于80%的所有備份。 |
|
vault_id |
否 |
String |
存儲(chǔ)庫(kù)ID |
請(qǐng)求參數(shù)
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用戶Token。 通過(guò)調(diào)用 IAM 服務(wù)獲取用戶Token接口獲?。憫?yīng)消息頭中X-Subject-Token的值）。 |
響應(yīng)參數(shù)
狀態(tài)碼： 200
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
backups |
備份列表 |
|
|
count |
Integer |
備份個(gè)數(shù) |
|
offset |
Integer |
偏移量，表示從此偏移量開(kāi)始查詢 最小值：0 缺省值：0 |
|
limit |
Integer |
每頁(yè)顯示的條目數(shù)量 最小值：1 最大值：1000 缺省值：1000 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
checkpoint_id |
String |
還原點(diǎn)ID |
|
created_at |
String |
創(chuàng)建時(shí)間，例如:"2020-02-05T10:38:34.209782" |
|
description |
String |
備份描述 |
|
expired_at |
String |
過(guò)期時(shí)間，例如:"2020-02-05T10:38:34.209782" |
|
extend_info |
擴(kuò)展信息 |
|
|
id |
String |
備份ID |
|
image_type |
String |
備份類型。取值為backup和replication。 |
|
name |
String |
備份名稱 |
|
parent_id |
String |
父?jìng)浞軮D |
|
project_id |
String |
項(xiàng)目ID |
|
protected_at |
String |
備份時(shí)間 |
|
resource_az |
String |
資源可用區(qū) |
|
resource_id |
String |
資源ID |
|
resource_name |
String |
資源名稱 |
|
resource_size |
Integer |
資源大小，單位為GB |
|
resource_type |
String |
資源類型: OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo, OS::Workspace::DesktopV2 |
|
status |
String |
備份狀態(tài) 枚舉值：
|
|
updated_at |
String |
更新時(shí)間，例如:"2020-02-05T10:38:34.209782" |
|
vault_id |
String |
存儲(chǔ)庫(kù)ID |
|
replication_records |
復(fù)制記錄 |
|
|
enterprise_project_id |
String |
企業(yè)項(xiàng)目id,默認(rèn)為‘0’。 |
|
provider_id |
String |
備份提供商ID，用于區(qū)分備份對(duì)象。當(dāng)前取值包含： 0daac4c5-6707-4851-97ba-169e36266b66，該值代表備份對(duì)象為 云服務(wù)器 。d1603440-187d-4516-af25-121250c7cc97，該值代表備份對(duì)象為 云硬盤(pán) 。3f3c3220-245c-4805-b811-758870015881， 該值代表備份對(duì)象為 SFS Turbo。a13639de-00be-4e94-af30-26912d75e4a2，該值代表備份對(duì)象為混合云VMware備份。 |
|
children |
子副本列表 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
auto_trigger |
Boolean |
是否是自動(dòng)生成的備份副本 |
|
bootable |
Boolean |
是否系統(tǒng)盤(pán)備份 |
|
incremental |
Boolean |
是否是增備 |
|
snapshot_id |
String |
卷備份副本的快照id |
|
support_lld |
Boolean |
是否支持lazyloading快速恢復(fù) |
|
supported_restore_mode |
String |
備份支持恢復(fù)的方式，當(dāng)前取值包含na,snapshot和backup。如果該字段取值為snapshot，代表備份此時(shí)已經(jīng)支持創(chuàng)建整機(jī) 鏡像 ；如果該字段取值為backup，備份支持通過(guò)云服務(wù)器上硬盤(pán)的備份進(jìn)行恢復(fù)；如果該字段取值為na，備份不支持直接恢復(fù)，只支持備份創(chuàng)建新資源等操作。 缺省值：na 枚舉值：
|
|
os_images_data |
備份注冊(cè)鏡像ID列表 |
|
|
contain_system_disk |
Boolean |
整機(jī)備份是否包含系統(tǒng)盤(pán) |
|
encrypted |
Boolean |
是否加密 |
|
system_disk |
Boolean |
是否是系統(tǒng)盤(pán) |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
created_at |
String |
復(fù)制的開(kāi)始時(shí)間 |
|
destination_backup_id |
String |
復(fù)制的目的備份ID |
|
destination_checkpoint_id |
String |
復(fù)制的目的備份記錄ID |
|
destination_project_id |
String |
復(fù)制的目標(biāo)項(xiàng)目ID |
|
destination_region |
String |
復(fù)制的目標(biāo)區(qū)域 |
|
destination_vault_id |
String |
目標(biāo)存儲(chǔ)庫(kù)ID |
|
extra_info |
復(fù)制附加信息 |
|
|
id |
String |
復(fù)制記錄ID |
|
source_backup_id |
String |
復(fù)制的源備份ID |
|
source_checkpoint_id |
String |
復(fù)制的源備份記錄ID |
|
source_project_id |
String |
復(fù)制的源項(xiàng)目ID |
|
source_region |
String |
復(fù)制的源區(qū)域 |
|
status |
String |
復(fù)制的狀態(tài) 枚舉值：
|
|
vault_id |
String |
備份所在的存儲(chǔ)庫(kù)ID |
請(qǐng)求示例
查詢所有備份副本。
GET https://{endpoint}/v3/{project_id}/backups
響應(yīng)示例
狀態(tài)碼： 200
OK
{
"count" : 2,
"backups" : [ {
"provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66",
"checkpoint_id" : "1fced58b-2a31-4851-bcbb-96216f83ce99",
"updated_at" : "2020-02-21T07:07:25.113761",
"vault_id" : "cca85ea5-00a4-418d-9222-bd83985bc515",
"id" : "b1c4afd9-e7a6-4888-9010-c2bac3aa7910",
"resource_az" : "br-iaas-odin1a",
"image_type" : "backup",
"resource_id" : "1a503932-ee8f-4dd5-8248-8dfb57e584c5",
"resource_size" : 40,
"children" : [ ],
"extend_info" : {
"auto_trigger" : true,
"supported_restore_mode" : "backup",
"contain_system_disk" : true,
"support_lld" : true,
"system_disk" : false
},
"project_id" : "0605767b5780d5762fc5c0118072a564",
"status" : "available",
"resource_name" : "test001-02",
"description" : "",
"expired_at" : "2020-05-21T07:00:54.060493",
"name" : "autobk_b629",
"created_at" : "2020-02-21T07:00:54.065135",
"resource_type" : "OS::Nova::Server"
}, {
"provider_id" : "d1603440-187d-4516-af25-121250c7cc97",
"checkpoint_id" : "f64c351f-769f-4c04-8806-fd90a59e9b12",
"updated_at" : "2020-02-21T07:09:37.767084",
"vault_id" : "79bd9daa-884f-4f84-b8fe-235d58cd927d",
"id" : "5606aab5-2dc2-4498-8144-dc848d099af5",
"resource_az" : "br-iaas-odin1a",
"image_type" : "backup",
"resource_id" : "54f7ccbc-072f-4ec5-a7b7-b24dabdb4539",
"resource_size" : 40,
"children" : [ ],
"extend_info" : {
"auto_trigger" : true,
"snapshot_id" : "e3def9a8-e4b4-4c12-b132-f4ba8ce9a34f",
"bootable" : true,
"support_lld" : true,
"encrypted" : false,
"system_disk" : false
},
"project_id" : "0605767b5780d5762fc5c0118072a564",
"status" : "available",
"resource_name" : "qsy_000",
"description" : "",
"expired_at" : "2020-03-22T07:00:34.877896",
"name" : "autobk_6809",
"created_at" : "2020-02-21T07:00:34.882174",
"resource_type" : "OS::Cinder::Volume"
} ]
}
狀態(tài)碼
|
狀態(tài)碼 |
描述 |
|---|---|
|
200 |
OK |
錯(cuò)誤碼
請(qǐng)參見(jiàn)錯(cuò)誤碼。
