華為云計(jì)算 云知識(shí) 批量創(chuàng)建保護(hù)實(shí)例BatchCreateProtectedInstances
批量創(chuàng)建保護(hù)實(shí)例BatchCreateProtectedInstances

 

功能介紹

典型場(chǎng)景:沒有特殊操作場(chǎng)景 接口功能:批量創(chuàng)建保護(hù)實(shí)例。保護(hù)實(shí)例創(chuàng)建完成后,系統(tǒng)默認(rèn)容災(zāi)站點(diǎn) 云服務(wù)器 名稱與生產(chǎn)站點(diǎn)云服務(wù)器名稱相同,但I(xiàn)D不同。

接口約束

接口約束: 保護(hù)組的狀態(tài)為available或者protected; 云服務(wù)器不能掛載共享 云硬盤 ; 云服務(wù)器不能已經(jīng)被創(chuàng)建保護(hù)實(shí)例; 云服務(wù)器必須與保護(hù)組在同一個(gè)VPC; 由 彈性伸縮 組伸縮時(shí)所創(chuàng)建的云服務(wù)器,在對(duì)該云服務(wù)器做容災(zāi)保護(hù)后,當(dāng)彈性伸縮組縮容時(shí),不支持對(duì)該云服務(wù)器執(zhí)行刪除操作。 創(chuàng)建保護(hù)實(shí)例時(shí),如果生產(chǎn)站點(diǎn)服務(wù)器為Windows云服務(wù)器且設(shè)置為密鑰方式登錄,請(qǐng)確保生產(chǎn)站點(diǎn)服務(wù)器使用的密鑰對(duì)存在,否則可能導(dǎo)致云平臺(tái)無(wú)法創(chuàng)建容災(zāi)站點(diǎn)云服務(wù)器,從而導(dǎo)致創(chuàng)建保護(hù)實(shí)例失?。ㄈ绻a(chǎn)站點(diǎn)云服務(wù)器對(duì)應(yīng)的密鑰對(duì)已被刪除,請(qǐng)重新創(chuàng)建相同名稱的密鑰對(duì))。 創(chuàng)建保護(hù)實(shí)例時(shí),選擇的生產(chǎn)站點(diǎn)云服務(wù)器如果加入了企業(yè)項(xiàng)目,保護(hù)實(shí)例創(chuàng)建成功后,容災(zāi)站點(diǎn)云服務(wù)器不會(huì)自動(dòng)加入企業(yè)項(xiàng)目,如有需要請(qǐng)手動(dòng)將容災(zāi)站點(diǎn)云服務(wù)器加入到企業(yè)項(xiàng)目。 創(chuàng)建保護(hù)實(shí)例完成并對(duì)生產(chǎn)站點(diǎn)的云服務(wù)器做容災(zāi)保護(hù)后,生產(chǎn)站點(diǎn)云服務(wù)器中的“主機(jī)名”、“云服務(wù)器名稱”、“安全組”、“委托”、“云服務(wù)器組”、“標(biāo)簽”和“自動(dòng)恢復(fù)”配置項(xiàng)修改不會(huì)再自動(dòng)同步到容災(zāi)站點(diǎn)的云服務(wù)器上。您可以在控制臺(tái)頁(yè)面上手動(dòng)將這些配置項(xiàng)的修改添加到容災(zāi)站點(diǎn)的云服務(wù)器上。

調(diào)試

您可以在API Explorer中調(diào)試該接口。

URI

POST /v1/{project_id}/protected-instances/batch

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

project_id

String

項(xiàng)目ID。

請(qǐng)求參數(shù)

表2 請(qǐng)求Header參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

X-Auth-Token

String

用戶Token。通過(guò)調(diào)用 IAM 服務(wù)獲取用戶Token接口獲?。憫?yīng)消息頭中X-Subject-Token的值)

表3 請(qǐng)求Body參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

protected_instances

BatchCreateProtectedInstancesRequestParams object

保護(hù)實(shí)例信息

表4 BatchCreateProtectedInstancesRequestParams

參數(shù)

是否必選

參數(shù)類型

描述

name_prefix

String

保護(hù)實(shí)例的名稱前綴,批量創(chuàng)建保護(hù)實(shí)例時(shí),為區(qū)分不同保護(hù)實(shí)例,創(chuàng)建過(guò)程中系統(tǒng)會(huì)自動(dòng)在名稱后加"-0001"的類似標(biāo)記,故此時(shí)名稱的長(zhǎng)度為[1-59]個(gè)字符。只包含中文字符、英文字母(a~z、A~Z)、數(shù)字(0~9)、小數(shù)點(diǎn)(.)、下劃線(_)、中劃線(-)。

最小長(zhǎng)度:1

最大長(zhǎng)度:59

description

String

保護(hù)實(shí)例的描述,最大支持長(zhǎng)度為64個(gè)字符。不能包含左尖括號(hào)(<)或右尖括號(hào)(>)。

最小長(zhǎng)度:1

最大長(zhǎng)度:64

server_group_id

String

需要加入的保護(hù)組ID。

cluster_id

String

專屬分布式存儲(chǔ) 池ID。當(dāng)容災(zāi)站點(diǎn)磁盤選擇專屬分布式存儲(chǔ)時(shí)指定該字段。

primary_subnet_id

String

容災(zāi)站點(diǎn)云服務(wù)器主網(wǎng)卡所在的子網(wǎng)subnetID,與neutron_network_id字段值一致。

tenancy

String

專屬主機(jī) 或共享池中創(chuàng)建容災(zāi)站點(diǎn)云服務(wù)器,默認(rèn)為在共享池中創(chuàng)建。值為:shared或dedicated。shared:表示共享池。dedicated:表示專屬主機(jī)。

缺省值:shared

枚舉值:

  • shared

  • dedicated

dedicated_host_id

String

專屬主機(jī)id,此屬性僅在tenancy值為dedicated時(shí)有效。若不指定此屬性,系統(tǒng)將自動(dòng)分配租戶可以自動(dòng)放置彈性云服務(wù)器的專屬主機(jī)。

servers

Array of ServerInfo objects

用于創(chuàng)建保護(hù)實(shí)例的云服務(wù)器信息列表。

tags

Array of ResourceTag objects

標(biāo)簽列表。

表5 ServerInfo

參數(shù)

是否必選

參數(shù)類型

描述

server_id

String

指定的生產(chǎn)站點(diǎn)云服務(wù)器ID。

flavorRef

String

指定的容災(zāi)站點(diǎn)云服務(wù)器的flavor ID。

表6 ResourceTag

參數(shù)

是否必選

參數(shù)類型

描述

key

String

鍵。同一資源的key值不能重復(fù)。最大長(zhǎng)度為36個(gè)UNICODE字符。key不能為空,不允許為空字符串。不能包含以下字符:非打印字符ASCII(0-31)特殊字符“*”,“<”,“>”,“\”,“=”,“,”,“|”,“/”鍵。不能為空。對(duì)于同一資源鍵值唯一。

value

String

值。最大長(zhǎng)度為43個(gè)UNICODE字符。value不能為空,可以為空字符串。不能包含以下字符:非打印字符ASCII(0-31)特殊字符“*”,“<”,“>”,“\”,“=”,“,”,“|”,“/”。長(zhǎng)度不超過(guò)43個(gè)字符。

響應(yīng)參數(shù)

狀態(tài)碼: 202

表7 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

job_id

String

成功返回jobId信息

狀態(tài)碼: 400

表8 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

失敗返回結(jié)構(gòu)

表9 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯(cuò)誤信息

code

String

錯(cuò)誤碼

狀態(tài)碼: 401

表10 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

失敗返回結(jié)構(gòu)

表11 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯(cuò)誤信息

code

String

錯(cuò)誤碼

狀態(tài)碼: 403

表12 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

失敗返回結(jié)構(gòu)

表13 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯(cuò)誤信息

code

String

錯(cuò)誤碼

狀態(tài)碼: 404

表14 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

失敗返回結(jié)構(gòu)

表15 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯(cuò)誤信息

code

String

錯(cuò)誤碼

狀態(tài)碼: 405

表16 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

失敗返回結(jié)構(gòu)

表17 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯(cuò)誤信息

code

String

錯(cuò)誤碼

狀態(tài)碼: 406

表18 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

失敗返回結(jié)構(gòu)

表19 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯(cuò)誤信息

code

String

錯(cuò)誤碼

狀態(tài)碼: 407

表20 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

失敗返回結(jié)構(gòu)

表21 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯(cuò)誤信息

code

String

錯(cuò)誤碼

狀態(tài)碼: 408

表22 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

失敗返回結(jié)構(gòu)

表23 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯(cuò)誤信息

code

String

錯(cuò)誤碼

狀態(tài)碼: 409

表24 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

失敗返回結(jié)構(gòu)

表25 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯(cuò)誤信息

code

String

錯(cuò)誤碼

狀態(tài)碼: 500

表26 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

失敗返回結(jié)構(gòu)

表27 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯(cuò)誤信息

code

String

錯(cuò)誤碼

狀態(tài)碼: 501

表28 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

失敗返回結(jié)構(gòu)

表29 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯(cuò)誤信息

code

String

錯(cuò)誤碼

狀態(tài)碼: 502

表30 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

失敗返回結(jié)構(gòu)

表31 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯(cuò)誤信息

code

String

錯(cuò)誤碼

狀態(tài)碼: 503

表32 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

失敗返回結(jié)構(gòu)

表33 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯(cuò)誤信息

code

String

錯(cuò)誤碼

狀態(tài)碼: 504

表34 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

失敗返回結(jié)構(gòu)

表35 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯(cuò)誤信息

code

String

錯(cuò)誤碼

請(qǐng)求示例

POST https://{Endpoint}/v1/{project_id}/protected-instances/batch

{
  "protected_instances" : {
    "name_prefix" : "test_protected_instance_name",
    "description" : "my description",
    "server_group_id" : "523ab8ad-3759-4933-9436-4cf4ebb20867",
    "primary_subnet_id" : "a32217fh-3413-c313-6342-3124d3491502",
    "servers" : [ {
      "server_id" : "403b603d-1d91-42cc-a357-81f3c2daf43f",
      "flavorRef" : "c3.medium.2"
    }, {
      "server_id" : "8f5dd226-6cc0-4fe8-9786-b8b3359b234b"
    } ],
    "tags" : [ {
      "key" : "test",
      "value" : "aaaaa"
    } ]
  }
}

響應(yīng)示例

狀態(tài)碼: 202

Accepted

{
  "job_id" : "0000000062db92d70162db9d200f00bb"
}

狀態(tài)碼: 400

Bad Request

{
  "error" : {
    "message" : "Server already used to create a protected instance",
    "code" : "SDRS.1305"
  }
}

狀態(tài)碼

狀態(tài)碼

描述

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

406

Not Acceptable

407

Proxy Authentication Required

408

Request Timeout

409

Conflict

500

Internal Server Error

501

Not Implemented

502

Bad Gateway

503

Service Unavailable

504

Gateway Timeout

錯(cuò)誤碼

請(qǐng)參見錯(cuò)誤碼。