功能介紹
該接口為擴(kuò)展接口,用戶在一個(gè)區(qū)域制作的私有 鏡像 ,可以通過(guò)跨Region復(fù)制鏡像將鏡像復(fù)制到其他區(qū)域,在其他區(qū)域發(fā)放相同類(lèi)型的 云服務(wù)器 ,幫助用戶實(shí)現(xiàn)區(qū)域間的業(yè)務(wù) 遷移 。
該接口為異步接口,返回job_id說(shuō)明任務(wù)下發(fā)成功,查詢異步任務(wù)狀態(tài),如果是success說(shuō)明任務(wù)執(zhí)行成功,如果是failed說(shuō)明任務(wù)執(zhí)行失敗。
約束與限制
調(diào)試
您可以在API Explorer中調(diào)試該接口。
URI
POST /v1/cloudimages/{image_id}/cross_region_copy
|
參數(shù) |
是否必選 |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|---|
|
image_id |
是 |
String |
鏡像ID。 如何獲取鏡像ID,請(qǐng)參見(jiàn)查詢鏡像列表。 |
請(qǐng)求消息
|
參數(shù) |
是否必選 |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|---|
|
name |
是 |
String |
鏡像名稱(chēng)。name參數(shù)說(shuō)明請(qǐng)參考鏡像屬性。 |
|
description |
否 |
String |
鏡像描述信息。_description參數(shù)說(shuō)明請(qǐng)參考鏡像屬性。支持字母、數(shù)字、中文等,不支持回車(chē)、<、>,長(zhǎng)度不能超過(guò)1024個(gè)字符。默認(rèn)為空。 |
|
region |
是 |
String |
目的區(qū)域的Region ID。 如何獲取Region ID列表,請(qǐng)參見(jiàn)“查詢區(qū)域列表”。 |
|
project_name |
是 |
String |
目的區(qū)域的項(xiàng)目名稱(chēng)。 |
|
agency_name |
是 |
String |
委托名稱(chēng)。 怎樣創(chuàng)建 IAM 委托,請(qǐng)參見(jiàn)“如何創(chuàng)建IAM委托?”。 |
|
vault_id |
否 |
String |
存儲(chǔ)庫(kù)ID。 如果是整機(jī)鏡像,則在跨Region復(fù)制鏡像時(shí),為必選參數(shù),需傳入該值。 存儲(chǔ)庫(kù)ID可以從 云備份 服務(wù)控制臺(tái)獲取,或者參考“查詢存儲(chǔ)庫(kù)列表”查詢。 |
請(qǐng)求示例
- 跨Region復(fù)制鏡像,其中,目的區(qū)域的Region ID為“region-1”、目的區(qū)域的項(xiàng)目名稱(chēng)為“project-1”。
POST https://{Endpoint}/v1/cloudimages/465076de-dc36-4aec-80f5-ef9d8009428f/cross_region_copy { "name":"test-copy-1001-4", "description":"test", "region":"region-1", "project_name":"project-1", "agency_name":"ims_copy_image" }
- 跨Region復(fù)制整機(jī)鏡像,其中,目的區(qū)域的Region ID為“region-1”、目的區(qū)域的項(xiàng)目名稱(chēng)為“project-1”、存儲(chǔ)庫(kù)ID為“6yhtb5df-1bc3-4c3f-893e-3e4716yhgt61”。
POST https://{Endpoint}/v1/cloudimages/465076de-dc36-4aec-80f5-ef9d8009428f/cross_region_copy { "name":"test-copy-1001-4", "description":"test", "region":"region-1", "project_name":"project-1", "agency_name":"ims_copy_image", "vault_id":"6yhtb5df-1bc3-4c3f-893e-3e4716yhgt61" }
響應(yīng)消息
- 響應(yīng)參數(shù)
參數(shù)
參數(shù)類(lèi)型
描述
job_id
String
異步任務(wù)ID。
- 響應(yīng)樣例
STATUS CODE 200
{ "job_id": "edc89b490d7d4392898e19b2deb34797" }
返回值
- 正常
- 異常
返回值
說(shuō)明
400 Bad Request
請(qǐng)求錯(cuò)誤,具體返回錯(cuò)誤碼請(qǐng)參錯(cuò)誤碼。
401 Unauthorized
鑒權(quán)失敗。
403 Forbidden
沒(méi)有操作權(quán)限。
404 Not Found
找不到資源。
500 Internal Server Error
服務(wù)內(nèi)部錯(cuò)誤。
503 Service Unavailable
服務(wù)不可用。
