# 更新保护实例名称 - UpdateProtectedInstanceName #### 功能介绍 更新某一个保护实例的名称。 #### 接口约束 无 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/SDRS/doc?api=UpdateProtectedInstanceName)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### URI PUT /v1/{project_id}/protected-instances/{protected_instance_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID。 | | protected_instance_id | 是 | String | 保护实例的ID。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | protected_instance | 是 | [UpdateProtectedInstanceNameRequestParams] object | 保护实例的信息。 | 表4UpdateProtectedInstanceNameRequestParams | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 是 | String | 保护实例的名称。最大支持长度为64个字节。只包含中文字符、英文字母（a～ｚ、Ａ～Ｚ）、数字（０\~９）、小数点（．）、下划线（_）、中划线（-）。 最小长度：**1** 最大长度：**64** | #### 响应参数 **状态码： 200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | protected_instance | [ShowProtectedInstanceParams] object | 保护实例的详细信息。 | 表6ShowProtectedInstanceParams | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | [MetadataParams] object | 保护实例元数据信息。 | | attachment | Array of [ProtectedInstanceAttachment] objects | 挂载的复制对列表。 | | tags | Array of [ResourceTag] objects | 标签列表。 | | progress | Integer | 保护实例的同步进度。单位：百分比（%）。 | | priority_station | String | 标识保护实例所在保护组的当前生产站点可用区。source：表示当前生产站点可用区为保护组source_availability_zone的值。target：表示当前生产站点可用区为保护组的target_availability_zone的值。 | 表7MetadataParams | 参数 | 参数类型 | 描述 | |:---|:---|:---| | __system__frozen | String | 保护实例元数据中资源冻结的字段。 true：表示资源被冻结。 空：表示资源没有被冻结。 | 表8ProtectedInstanceAttachment | 参数 | 参数类型 | 描述 | |:---|:---|:---| | replication | String | 复制对ID。 | | device | String | 挂载点。 | 表9ResourceTag | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | 键。同一资源的key值不能重复。最大长度为36个UNICODE字符。key不能为空，不允许为空字符串。不能包含以下字符：非打印字符ASCII(0-31)特殊字符"\*","\<","\>","\\","=",",","\|","/"键。不能为空。对于同一资源键值唯一。 | | value | String | 值。最大长度为43个UNICODE字符。value不能为空，可以为空字符串。不能包含以下字符：非打印字符ASCII(0-31)特殊字符"\*","\<","\>","\\","=",",","\|","/"。长度不超过43个字符。 | **状态码： 400** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [ErrorInfo] object | 失败返回结构 | 表11ErrorInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | message | String | 错误信息 | | code | String | 错误码 | **状态码： 401** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [ErrorInfo] object | 失败返回结构 | 表13ErrorInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | message | String | 错误信息 | | code | String | 错误码 | **状态码： 403** 表14响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [ErrorInfo] object | 失败返回结构 | 表15ErrorInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | message | String | 错误信息 | | code | String | 错误码 | **状态码： 405** 表16响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [ErrorInfo] object | 失败返回结构 | 表17ErrorInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | message | String | 错误信息 | | code | String | 错误码 | **状态码： 406** 表18响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [ErrorInfo] object | 失败返回结构 | 表19ErrorInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | message | String | 错误信息 | | code | String | 错误码 | **状态码： 407** 表20响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [ErrorInfo] object | 失败返回结构 | 表21ErrorInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | message | String | 错误信息 | | code | String | 错误码 | **状态码： 408** 表22响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [ErrorInfo] object | 失败返回结构 | 表23ErrorInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | message | String | 错误信息 | | code | String | 错误码 | **状态码： 409** 表24响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [ErrorInfo] object | 失败返回结构 | 表25ErrorInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | message | String | 错误信息 | | code | String | 错误码 | **状态码： 500** 表26响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [ErrorInfo] object | 失败返回结构 | 表27ErrorInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | message | String | 错误信息 | | code | String | 错误码 | **状态码： 501** 表28响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [ErrorInfo] object | 失败返回结构 | 表29ErrorInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | message | String | 错误信息 | | code | String | 错误码 | **状态码： 502** 表30响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [ErrorInfo] object | 失败返回结构 | 表31ErrorInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | message | String | 错误信息 | | code | String | 错误码 | **状态码： 503** 表32响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [ErrorInfo] object | 失败返回结构 | 表33ErrorInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | message | String | 错误信息 | | code | String | 错误码 | **状态码： 504** 表34响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [ErrorInfo] object | 失败返回结构 | 表35ErrorInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-sdrs/ErrorCode.html)。