華為云計算 云知識 批量創(chuàng)建保護實例BatchCreateProtectedInstances
批量創(chuàng)建保護實例BatchCreateProtectedInstances

 

功能介紹

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

接口約束

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

調(diào)試

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

URI

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

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

project_id

String

項目ID。

請求參數(shù)

表2 請求Header參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

X-Auth-Token

String

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

表3 請求Body參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

protected_instances

BatchCreateProtectedInstancesRequestParams object

保護實例信息

表4 BatchCreateProtectedInstancesRequestParams

參數(shù)

是否必選

參數(shù)類型

描述

name_prefix

String

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

最小長度:1

最大長度:59

description

String

保護實例的描述,最大支持長度為64個字符。不能包含左尖括號(<)或右尖括號(>)。

最小長度:1

最大長度:64

server_group_id

String

需要加入的保護組ID。

cluster_id

String

專屬分布式存儲 池ID。當容災(zāi)站點磁盤選擇專屬分布式存儲時指定該字段。

primary_subnet_id

String

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

tenancy

String

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

缺省值:shared

枚舉值:

  • shared

  • dedicated

dedicated_host_id

String

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

servers

Array of ServerInfo objects

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

tags

Array of ResourceTag objects

標簽列表。

表5 ServerInfo

參數(shù)

是否必選

參數(shù)類型

描述

server_id

String

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

flavorRef

String

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

表6 ResourceTag

參數(shù)

是否必選

參數(shù)類型

描述

key

String

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

value

String

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

響應(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

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 401

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

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

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

表11 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 403

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

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

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

表13 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 404

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

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

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

表15 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 405

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

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

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

表17 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 406

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

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

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

表19 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 407

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

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

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

表21 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 408

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

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

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

表23 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 409

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

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

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

表25 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 500

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

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

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

表27 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 501

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

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

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

表29 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 502

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

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

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

表31 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 503

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

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

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

表33 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 504

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

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

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

表35 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

請求示例

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

錯誤碼

請參見錯誤碼。