响应参数
5.4 保护组
5.4.5 更新保护组名称
功能介绍
更新某一个保护组的名称。
接口约束
无
调试
您可以在API Explorer中调试该接口。
URI
PUT /v1/{project_id}/server-groups/{server_group_id}
表5-250 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID。
server_group_
id 是 String 保护组ID。
请求参数
表5-251 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取用户Token接口获取（响应 消息头中X-Subject-Token的 值）
表5-252 请求 Body 参数
参数 是否必选 参数类型 描述
server_group 是 UpdateProte ctionGroupN ameRequest Params object
保护组信息。
表5-253 UpdateProtectionGroupNameRequestParams
参数 是否必选 参数类型 描述
name 是 String 保护组的名称。 最大支持长度
为64个字节。 只包含中文字 符、英文字母（a～ｚ、Ａ～
Ｚ）、数字（０~９）、小数点
（．）、下划线（_）、中划线
（-）。
最小长度：1 最大长度：64
响应参数
状态码： 200
表5-254 响应 Body 参数
参数 参数类型 描述
server_group ShowProtecti onGroupPara ms object
保护组的详细信息。
表5-255 ShowProtectionGroupParams
参数 参数类型 描述
id String 保护组的ID。
name String 保护组的名称。
description String 保护组的描述。
status String 保护组的状态。
progress Integer 保护组的同步进度。单位：百分比（%）。
最小值：0 最大值：100 source_availa
bility_zone String 保护组创建时的生产站点可用区名称。注意：保 护组切换、故障切换后，该值不变。
target_availab
ility_zone String 保护组创建时的容灾站点可用区名称。注意：保 护组切换、故障切换后，该值不变。
domain_id String 双活域ID。
domain_name String 双活域名称。
priority_statio
n String 用于标识保护组的当前生产站点。 source：表示 当前生产站点可用区为source_availability_zone 的值。 target：表示当前生产站点可用区为 target_availability_zone的值。
protected_inst
ance_num Integer 该保护组中保护实例的个数。
replication_nu
m Integer 该保护组中复制对的个数。
disaster_recov
ery_drill_num Integer 该保护组中容灾演练的个数。
protected_stat
us String 保护状态。started：表示该保护组开始保护。
stopped：表示该保护组停止保护。 说明:系统近 期进行了升级，对于升级后创建的保护组，该字 段值为null，无实际意义。
枚举值：
● started
● stopped
参数 参数类型 描述 replication_st
atus String 数据同步状态。 active：表示数据已同步完成。
inactive：表示数据未同步。 copying：表示数据 正在同步。 active-stopped：表示数据已停止同 步。 说明:系统近期进行了升级，对于升级后创建 的保护组，该字段值为null，无实际意义。
枚举值：
● active
● inactive
● copying
● active-stopped
health_status String 健康状态。 normal：表示该保护组处于正常状 态。 abnormal：表示该保护组处于非正常状 态。 说明:系统近期进行了升级，对于升级后创建 的保护组，该字段值为null，无实际意义。
枚举值：
● normal
● abnormal
● null
source_vpc_id String 生产站点虚拟私有云ID。
target_vpc_id String 容灾站点虚拟私有云ID。
test_vpc_id String 容灾演练虚拟私有云ID。（该参数暂未使用）
dr_type String 部署模式。默认值为“migration”，migration 表示VPC内迁移。
created_at String 创建时间。默认格式为："yyyy-MM-dd'T'HH:mm:ss.SSSZ"，例：
"2019-04-01T12:00:00.000Z"。
updated_at String 更新时间。默认格式为："yyyy-MM-dd'T'HH:mm:ss.SSSZ"，例：
"2019-04-01T12:00:00.000Z"。
参数 参数类型 描述 protection_ty
pe String 保护模式。 replication-pair：表示以复制对为单 位进行数据同步。 null：表示将保护组中的所有 复制对作为一个整体进行数据同步。 说明:当保护 组中的所有复制对作为一个整体进行数据同步 时，如果数据同步失败，保护组中的所有复制对 都会受到影响。因此，SDRS服务对系统做了优化 升级： 对于升级后创建的资源，默认以复制对为 单位进行数据同步，返回值为replication-pair；
对于已有资源，仍以一个整体进行数据同步，返 回值为null。
枚举值：
● replication-pair
● null replication_m
odel String 复制类型。 说明:预留参数，暂未启用。
server_type String 管理的服务器类型 ECS：表示管理的服务器类型 为云服务器。
状态码： 400
表5-256 响应 Body 参数
参数 参数类型 描述
error ErrorInfo
object 失败返回结构
表5-257 ErrorInfo
参数 参数类型 描述
message String 错误信息
code String 错误码
状态码： 401
表5-258 响应 Body 参数
参数 参数类型 描述
error ErrorInfo
object 失败返回结构
表5-259 ErrorInfo
参数 参数类型 描述
message String 错误信息
code String 错误码
状态码： 403
表5-260 响应 Body 参数
参数 参数类型 描述
error ErrorInfo
object 失败返回结构
表5-261 ErrorInfo
参数 参数类型 描述
message String 错误信息
code String 错误码
状态码： 405
表5-262 响应 Body 参数
参数 参数类型 描述
error ErrorInfo
object 失败返回结构
表5-263 ErrorInfo
参数 参数类型 描述
message String 错误信息
code String 错误码
状态码： 406
表5-264 响应 Body 参数
参数 参数类型 描述
error ErrorInfo
object 失败返回结构
表5-265 ErrorInfo
参数 参数类型 描述
message String 错误信息
code String 错误码
状态码： 407
表5-266 响应 Body 参数
参数 参数类型 描述
error ErrorInfo
object 失败返回结构
表5-267 ErrorInfo
参数 参数类型 描述
message String 错误信息
code String 错误码
状态码： 408
表5-268 响应 Body 参数
参数 参数类型 描述
error ErrorInfo
object 失败返回结构
表5-269 ErrorInfo
参数 参数类型 描述
message String 错误信息
code String 错误码
状态码： 409
表5-270 响应 Body 参数
参数 参数类型 描述
error ErrorInfo
object 失败返回结构
表5-271 ErrorInfo
参数 参数类型 描述
message String 错误信息
code String 错误码
状态码： 500
表5-272 响应 Body 参数
参数 参数类型 描述
error ErrorInfo
object 失败返回结构
表5-273 ErrorInfo
参数 参数类型 描述
message String 错误信息
code String 错误码
状态码： 501
表5-274 响应 Body 参数
参数 参数类型 描述
error ErrorInfo
object 失败返回结构
表5-275 ErrorInfo
参数 参数类型 描述
message String 错误信息
code String 错误码
状态码： 502
表5-276 响应 Body 参数
参数 参数类型 描述
error ErrorInfo
object 失败返回结构
表5-277 ErrorInfo
参数 参数类型 描述
message String 错误信息
code String 错误码
状态码： 503
表5-278 响应 Body 参数
参数 参数类型 描述
error ErrorInfo
object 失败返回结构
表5-279 ErrorInfo
参数 参数类型 描述
message String 错误信息
code String 错误码
状态码： 504
表5-280 响应 Body 参数
参数 参数类型 描述
error ErrorInfo
object 失败返回结构
表5-281 ErrorInfo
参数 参数类型 描述
message String 错误信息
code String 错误码
请求示例
PUT https://{endpoint}/v1/{project_id}/server-groups/ e98cefcd-2398-4a4d-8c52-c79f00e21484 { "server_group" : {
"name" : "my_test_server_group"
}}
响应示例
状态码： 200 OK
{ "server_group" : {
"id" : "decf224d-87fe-403a-8721-037a1a45c287", "name" : "Protection-Group-lwx",
"description" : null,
"source_availability_zone" : "cn-north-1a", "target_availability_zone" : "cn-north-1b",
"domain_id" : "fb4bb8e3-a574-4437-a156-78c916aeea4d", "domain_name" : "ActiveactiveDomain",
"status" : "available", "protected_status" : null, "replication_status" : null, "health_status" : null, "progress" : 0,
"priority_station" : "source", "protected_instance_num" : 0, "replication_num" : 0,
"disaster_recovery_drill_num" : 0,
"source_vpc_id" : "046852ef-c49d-409b-8389-546aaaa5701f", "target_vpc_id" : "046852ef-c49d-409b-8389-546aaaa5701f", "test_vpc_id" : null,
"dr_type" : "migration",
"created_at" : "2019-05-22 08:16:54.413", "updated_at" : "2019-05-23 09:11:10.856", "protection_type" : "replication-pair", "replication_model" : null
}}
状态码
状态码 描述
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
错误码
请参见错误码。