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

 

功能介紹

創(chuàng)建保護實例。保護實例創(chuàng)建完成后,系統(tǒng)默認容災站點 云服務器 名稱與生產(chǎn)站點云服務器名稱相同,但ID不同。如果需要修改云服務器名稱,請在保護實例詳情頁面單擊云服務器名稱,進入云服務器詳情頁面進行修改

接口約束

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

調(diào)試

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

URI

POST /v1/{project_id}/protected-instances

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

project_id

String

項目ID。

請求參數(shù)

表2 請求Header參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

X-Auth-Token

String

用戶Token。通過調(diào)用 IAM 服務獲取用戶Token接口獲取(響應消息頭中X-Subject-Token的值)

表3 請求Body參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

protected_instance

CreateProtectedInstanceRequestParams object

保護實例的信息。

表4 CreateProtectedInstanceRequestParams

參數(shù)

是否必選

參數(shù)類型

描述

server_group_id

String

需要加入的保護組ID。

server_id

String

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

name

String

指定保護實例的名稱,最大支持長度為64個字節(jié)。只包含中文字符、英文字母(a~z、A~Z)、數(shù)字(0~9)、小數(shù)點(.)、下劃線(_)、中劃線(-)。

最小長度:1

最大長度:64

description

String

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

最小長度:1

最大長度:64

cluster_id

String

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

primary_subnet_id

String

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

primary_ip_address

String

容災站點云服務器主網(wǎng)卡IP地址。此參數(shù)僅在傳入primary_subnet_id時有效。指定primary_subnet_id時,如果不指定該參數(shù),將自動分配容災站點云服務器主網(wǎng)卡IP地址。

tags

Array of ResourceTag objects

標簽列表。

flavorRef

String

指定的容災站點云服務器的flavor ID。 查詢flavor列表,請參見查詢云服務器規(guī)格變更支持列表。 說明:不指定此參數(shù)時,容災站點云服務器的flavor ID默認和生產(chǎn)站點云服務器保持一致。 不同規(guī)格的云服務器在性能上存在差異,可能會對云服務器上運行的應用產(chǎn)生影響。為保證切換/故障切換后云服務器的性能,建議容災站點服務器的規(guī)格(CPU、內(nèi)存)不低于生產(chǎn)站點云服務器的規(guī)格(CPU、內(nèi)存)。 生產(chǎn)站點云服務器和容災站點云服務器的flavor存在匹配關(guān)系,可以通過上述接口使用生產(chǎn)站點云服務器過濾出滿足要求的容災站點云服務器flavor。

tenancy

String

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

缺省值:shared

枚舉值:

  • shared

  • dedicated

dedicated_host_id

String

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

表5 ResourceTag

參數(shù)

是否必選

參數(shù)類型

描述

key

String

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

value

String

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

響應參數(shù)

狀態(tài)碼: 200

表6 響應Body參數(shù)

參數(shù)

參數(shù)類型

描述

job_id

String

成功返回jobId信息

狀態(tài)碼: 400

表7 響應Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

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

表8 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 401

表9 響應Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

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

表10 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 403

表11 響應Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

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

表12 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 404

表13 響應Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

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

表14 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 405

表15 響應Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

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

表16 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 406

表17 響應Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

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

表18 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 407

表19 響應Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

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

表20 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 408

表21 響應Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

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

表22 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 409

表23 響應Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

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

表24 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 500

表25 響應Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

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

表26 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 501

表27 響應Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

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

表28 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 502

表29 響應Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

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

表30 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 503

表31 響應Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

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

表32 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 504

表33 響應Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

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

表34 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

請求示例

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

{
  "protected_instance" : {
    "server_group_id" : "523ab8ad-3759-4933-9436-4cf4ebb20867",
    "server_id" : "403b603d-1d91-42cc-a357-81f3c2daf43f",
    "name" : "test_protected_instance_name",
    "description" : "my description",
    "primary_subnet_id" : "a32217fh-3413-c313-6342-3124d3491502",
    "primary_ip_address" : "192.168.0.5",
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    }, {
      "key" : "key",
      "value" : "value3"
    } ]
  }
}

響應示例

狀態(tài)碼: 200

OK

{
  "job_id" : "0000000062db92d70162db9d200f00bb"
}

狀態(tài)碼

狀態(tài)碼

描述

200

OK

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

錯誤碼

請參見錯誤碼