華為云計算 云知識 更新保護(hù)實(shí)例名稱UpdateProtectedInstanceName
更新保護(hù)實(shí)例名稱UpdateProtectedInstanceName

 

功能介紹

更新某一個保護(hù)實(shí)例的名稱。

接口約束

調(diào)試

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

URI

PUT /v1/{project_id}/protected-instances/{protected_instance_id}

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

project_id

String

項目ID。

protected_instance_id

String

保護(hù)實(shí)例的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_instance

UpdateProtectedInstanceNameRequestParams object

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

表4 UpdateProtectedInstanceNameRequestParams

參數(shù)

是否必選

參數(shù)類型

描述

name

String

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

最小長度:1

最大長度:64

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

狀態(tài)碼: 200

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

參數(shù)

參數(shù)類型

描述

protected_instance

ShowProtectedInstanceParams object

保護(hù)實(shí)例的詳細(xì)信息。

表6 ShowProtectedInstanceParams

參數(shù)

參數(shù)類型

描述

id

String

保護(hù)實(shí)例的ID。

name

String

保護(hù)實(shí)例的名稱。

description

String

保護(hù)實(shí)例的描述。

status

String

保護(hù)實(shí)例的狀態(tài)。

source_server

String

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

target_server

String

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

server_group_id

String

保護(hù)組的ID。

created_at

String

創(chuàng)建時間。默認(rèn)格式為:"yyyy-MM-dd HH:mm:ss.SSS",例:"2019-04-01 12:00:00.000"。

updated_at

String

更新時間。默認(rèn)格式為:"yyyy-MM-dd HH:mm:ss.SSS",例:"2019-04-01 12:00:00.000"。

metadata

MetadataParams object

保護(hù)實(shí)例元數(shù)據(jù)信息。

attachment

Array of ProtectedInstanceAttachment objects

掛載的復(fù)制對列表。

tags

Array of ResourceTag objects

標(biāo)簽列表。

progress

Integer

保護(hù)實(shí)例的同步進(jìn)度。單位:百分比(%)。

priority_station

String

標(biāo)識保護(hù)實(shí)例所在保護(hù)組的當(dāng)前生產(chǎn)站點(diǎn)可用區(qū)。source:表示當(dāng)前生產(chǎn)站點(diǎn)可用區(qū)為保護(hù)組source_availability_zone的值。target:表示當(dāng)前生產(chǎn)站點(diǎn)可用區(qū)為保護(hù)組的target_availability_zone的值。

表7 MetadataParams

參數(shù)

參數(shù)類型

描述

__system__frozen

String

保護(hù)實(shí)例元數(shù)據(jù)中資源凍結(jié)的字段。 true:表示資源被凍結(jié)。 空:表示資源沒有被凍結(jié)。

表8 ProtectedInstanceAttachment

參數(shù)

參數(shù)類型

描述

replication

String

復(fù)制對ID。

device

String

掛載點(diǎn)。

表9 ResourceTag

參數(shù)

參數(shù)類型

描述

key

String

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

value

String

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

狀態(tài)碼: 400

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

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

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

表11 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 401

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

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

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

表13 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 403

表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

錯誤碼

請求示例

PUT https://{Endpoint}/v1/{project_id}/protected-instances/00000000632302f501632305f63c000e

{
  "protected_instance" : {
    "name" : "test_protected_instance_name"
  }
}

響應(yīng)示例

狀態(tài)碼: 200

OK

{
  "protected_instance" : {
    "id" : "00000000632302f501632305f63c000e",
    "name" : "test_protected_instance_name",
    "description" : "_sdrs_protected_instance",
    "server_group_id" : "00000000632302f501632305ac75000a",
    "status" : "available",
    "progress" : 0,
    "source_server" : "5597a320-7a36-4462-9f85-a0d01edfb416",
    "target_server" : "e37ed7de-bd76-4189-8445-be747205322d",
    "created_at" : "2018-05-02 22:43:03.0",
    "updated_at" : "2018-05-02 22:47:27.0",
    "priority_station" : "target",
    "attachment" : [ {
      "replication" : "6568f7c4-0510-4f39-929d-8ffccbd4fd47",
      "device" : "/dev/vda"
    } ],
    "tags" : [ {
      "key" : "aaaaaaa",
      "value" : "01234567889"
    }, {
      "key" : "ffffff",
      "value" : "dddd"
    } ],
    "metadata" : { }
  }
}

狀態(tài)碼

狀態(tài)碼

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

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

錯誤碼

請參見錯誤碼。