功能介紹
創(chuàng)建 云硬盤 快照。
調(diào)試
您可以在API Explorer中調(diào)試該接口，支持自動認(rèn)證鑒權(quán)。API Explorer可以自動生成SDK代碼示例，并提供SDK代碼示例調(diào)試功能。
URI
POST /v2/{project_id}/cloudsnapshots
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
項目ID。 獲取方法請參見"獲取項目ID"。 |
請求參數(shù)
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用戶Token。 通過調(diào)用 IAM 服務(wù)獲取用戶Token接口獲取（響應(yīng)消息頭中X-Subject-Token的值）。 |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
volume_id |
是 |
String |
源云硬盤的ID。 |
|
force |
否 |
Boolean |
強制創(chuàng)快照標(biāo)示，默認(rèn)為false。 當(dāng)force標(biāo)記為false時，云硬盤處于掛載狀態(tài)時，不能強制創(chuàng)建快照。 當(dāng)force標(biāo)記為true時，即使云硬盤處于掛載狀態(tài)時，仍可以創(chuàng)建快照。 |
|
metadata |
否 |
Map<String,String> |
云硬盤快照的元數(shù)據(jù)信息。 |
|
description |
否 |
String |
云硬盤快照描述，最大支持255個字節(jié)。 最小長度：0 最大長度：255 |
|
name |
否 |
String |
云硬盤快照名稱。最大支持255個字節(jié)。>> 對云硬盤創(chuàng)建備份時，同時會創(chuàng)建以autobk_snapshot_為名稱前綴的快照，云硬盤控制臺對此類快照會有操作限制。因此建議不要創(chuàng)建以> > autobk_snapshot_為名稱前綴的快照，避免影響快照的正常使用 最小長度：0 最大長度：255 |
響應(yīng)參數(shù)
狀態(tài)碼： 202
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
id |
String |
云硬盤快照ID。 |
|
status |
String |
云硬盤快照狀態(tài)。 |
|
name |
String |
云硬盤快照名稱。 |
|
description |
String |
云硬盤快照描述信息。 |
|
created_at |
String |
云硬盤快照創(chuàng)建時間。 時間格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX |
|
updated_at |
String |
快照更新時間。 時間格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX |
|
metadata |
Object |
云硬盤快照的元數(shù)據(jù)信息。 |
|
volume_id |
String |
快照所屬的云硬盤ID。 |
|
size |
Integer |
云硬盤快照大小，單位為GiB。 |
|
os-extended-snapshot-attributes:project_id |
String |
預(yù)留屬性。 |
|
os-extended-snapshot-attributes:progress |
String |
預(yù)留屬性。 |
狀態(tài)碼： 400
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
error |
出現(xiàn)錯誤時，返回的錯誤信息，具體請參見 error參數(shù)說明。 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
code |
String |
出現(xiàn)錯誤時，返回的錯誤碼。錯誤碼和其對應(yīng)的含義請參考錯誤碼說明。 |
|
message |
String |
出現(xiàn)錯誤時，返回的錯誤消息。 |
請求示例
創(chuàng)建一個云硬盤快照，當(dāng)源云硬盤處于掛載狀態(tài)時，不能強制創(chuàng)建快照。
POST https://{endpoint}/v2/{project_id}/cloudsnapshots
{
"snapshot" : {
"name" : "snap-001",
"description" : "Daily backup",
"volume_id" : "5aa119a8-d25b-45a7-8d1b-88e127885635",
"force" : false,
"metadata" : { }
}
}
響應(yīng)示例
狀態(tài)碼： 202
Accepted
{
"snapshot" : {
"status" : "creating",
"description" : "Daily backup",
"created_at" : "2013-02-25T03:56:53.081642",
"metadata" : { },
"volume_id" : "5aa119a8-d25b-45a7-8d1b-88e127885635",
"size" : 1,
"id" : "ffa9bc5e-1172-4021-acaf-cdcd78a9584d",
"name" : "snap-001",
"updated_at" : "2013-02-25T03:56:53.081642"
}
}
狀態(tài)碼： 400
Bad Request
{
"error" : {
"message" : "XXXX",
"code" : "XXX"
}
}
狀態(tài)碼
|
狀態(tài)碼 |
描述 |
|---|---|
|
202 |
Accepted |
|
400 |
Bad Request |
錯誤碼
請參見錯誤碼。
