响应参数
5.5 保护实例
5.5.7 更新保护实例名称
功能介绍
更新某一个保护实例的名称。
接口约束
无
调试
您可以在API Explorer中调试该接口。
URI
PUT /v1/{project_id}/protected-instances/{protected_instance_id}
表5-614 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID。
protected_inst
ance_id 是 String 保护实例的ID。
请求参数
表5-615 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取用户Token接口获取（响应 消息头中X-Subject-Token的 值）
表5-616 请求 Body 参数
参数 是否必选 参数类型 描述
protected_inst
ance 是 UpdateProte
ctedInstance NameReques tParams object
保护实例的信息。
表5-617 UpdateProtectedInstanceNameRequestParams
参数 是否必选 参数类型 描述
ance ShowProtect
edInstancePa rams object
保护实例的详细信息。
表5-619 ShowProtectedInstanceParams
参数 参数类型 描述
id String 保护实例的ID。
name String 保护实例的名称。
description String 保护实例的描述。
status String 保护实例的状态。
source_server String 生产站点云服务器ID。
参数 参数类型 描述
target_server String 容灾站点云服务器ID。
server_group_
id String 保护组的ID。
created_at String 创建时间。默认格式为："yyyy-MM-dd HH:mm:ss.SSS"，例："2019-04-01 12:00:00.000"。
updated_at String 更新时间。默认格式为："yyyy-MM-dd HH:mm:ss.SSS"，例："2019-04-01 12:00:00.000"。
metadata MetadataPar
ams object 保护实例元数据信息。
attachment Array of ProtectedInst anceAttachm ent objects
挂载的复制对列表。
tags Array of ResourceTag objects
标签列表。
progress Integer 保护实例的同步进度。单位：百分比（%）。
priority_statio
表5-620 MetadataParams
参数 参数类型 描述
__system__fro
zen String 保护实例元数据中资源冻结的字段。 true：表示 资源被冻结。 空：表示资源没有被冻结。
表5-621 ProtectedInstanceAttachment
参数 参数类型 描述
replication String 复制对ID。
device String 挂载点。
表5-622 ResourceTag
参数 参数类型 描述
key String 键。同一资源的key值不能重复。最大长度为36个 UNICODE字符。key不能为空，不允许为空字符 串。不能包含以下字符：非打印字符ASCII(0-31) 特殊字符“*”,“<”,“>”,“\”,“=”,“,”,
“|”,“/”键。不能为空。对于同一资源键值唯 一。
value String 值。最大长度为43个UNICODE字符。value不能 为空，可以为空字符串。不能包含以下字符：非 打印字符ASCII(0-31)特殊字符“*”,“<”,“>”,
“\”,“=”,“,”,“|”,“/”。长度不超过43个 字符。
状态码： 400
表5-623 响应 Body 参数
参数 参数类型 描述
error ErrorInfo
object 失败返回结构
表5-624 ErrorInfo
参数 参数类型 描述
message String 错误信息
code String 错误码
状态码： 401
表5-625 响应 Body 参数
参数 参数类型 描述
error ErrorInfo
object 失败返回结构
表5-626 ErrorInfo
参数 参数类型 描述
message String 错误信息
code String 错误码
状态码： 403
表5-627 响应 Body 参数
参数 参数类型 描述
error ErrorInfo
object 失败返回结构
表5-628 ErrorInfo
参数 参数类型 描述
message String 错误信息
code String 错误码
状态码： 405
表5-629 响应 Body 参数
参数 参数类型 描述
error ErrorInfo
object 失败返回结构
表5-630 ErrorInfo
参数 参数类型 描述
message String 错误信息
code String 错误码
状态码： 406
表5-631 响应 Body 参数
参数 参数类型 描述
error ErrorInfo
object 失败返回结构
表5-632 ErrorInfo
参数 参数类型 描述
message String 错误信息
code String 错误码
状态码： 407
表5-633 响应 Body 参数
参数 参数类型 描述
error ErrorInfo
object 失败返回结构
表5-634 ErrorInfo
参数 参数类型 描述
message String 错误信息
code String 错误码
状态码： 408
表5-635 响应 Body 参数
参数 参数类型 描述
error ErrorInfo
object 失败返回结构
表5-636 ErrorInfo
参数 参数类型 描述
message String 错误信息
code String 错误码
状态码： 409
表5-637 响应 Body 参数
参数 参数类型 描述
error ErrorInfo
object 失败返回结构
表5-638 ErrorInfo
参数 参数类型 描述
message String 错误信息
code String 错误码
状态码： 500
表5-639 响应 Body 参数
参数 参数类型 描述
error ErrorInfo
object 失败返回结构
表5-640 ErrorInfo
参数 参数类型 描述
message String 错误信息
code String 错误码
状态码： 501
表5-641 响应 Body 参数
参数 参数类型 描述
error ErrorInfo
object 失败返回结构
表5-642 ErrorInfo
参数 参数类型 描述
message String 错误信息
code String 错误码
状态码： 502
表5-643 响应 Body 参数
参数 参数类型 描述
error ErrorInfo
object 失败返回结构
表5-644 ErrorInfo
参数 参数类型 描述
message String 错误信息
code String 错误码
状态码： 503
表5-645 响应 Body 参数
参数 参数类型 描述
error ErrorInfo
object 失败返回结构
表5-646 ErrorInfo
参数 参数类型 描述
message String 错误信息
code String 错误码
状态码： 504
表5-647 响应 Body 参数
参数 参数类型 描述
error ErrorInfo
object 失败返回结构
表5-648 ErrorInfo
参数 参数类型 描述
message String 错误信息
code String 错误码
请求示例
PUT https://{Endpoint}/v1/{project_id}/protected-instances/00000000632302f501632305f63c000e { "protected_instance" : {
"name" : "test_protected_instance_name"
}}
响应示例
状态码： 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" : { } }}
状态码
状态码 描述
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
错误码
请参见错误码。