文档首页/ 业务恢复服务 BRS/ API参考/ API/ 保护组/ 创建保护组 - CreateProtectionGroup

更新时间：2025-11-26 GMT+08:00

创建保护组 - CreateProtectionGroup

功能介绍

创建保护组。说明：本接口为异步接口，调用成功只是表示请求下发，创建结果需要通过“查询job状态”接口获取

接口约束

无

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v1/{project_id}/server-groups

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）

表3 请求Body参数
参数	是否必选	参数类型	描述
server_group	是	CreateProtectionGroupRequestParams object	保护组信息。

表4 CreateProtectionGroupRequestParams
参数	是否必选	参数类型	描述
name	是	String	指定保护组的名称，最大支持长度为64个字节。只包含中文字符、英文字母（a～ｚ、Ａ～Ｚ）、数字（０~９）、小数点（．）、下划线（_）、中划线（-）。最小长度：1 最大长度：64
description	否	String	指定保护组的描述，最大支持长度为64个字节。不能包含左尖括号（<）或右尖括号（>）。最小长度：1 最大长度：64
source_availability_zone	是	String	指定保护组的生产站点可用区名称。
target_availability_zone	是	String	指定保护组的容灾站点可用区名称。
domain_id	是	String	指定双活域的ID。
source_vpc_id	是	String	生产站点虚拟私有云ID。
dr_type	否	String	部署模式。默认值为“migration”，migration表示VPC内迁移。缺省值：migration 枚举值： migration

响应参数

状态码： 200

表5 响应Body参数
参数	参数类型	描述
job_id	String	成功返回jobId信息

状态码： 400

表6 响应Body参数
参数	参数类型	描述
error	ErrorInfo object	失败返回结构

表7 ErrorInfo
参数	参数类型	描述
message	String	错误信息
code	String	错误码

状态码： 401

表8 响应Body参数
参数	参数类型	描述
error	ErrorInfo object	失败返回结构

表9 ErrorInfo
参数	参数类型	描述
message	String	错误信息
code	String	错误码

状态码： 403

**表10** 响应Body参数
参数	参数类型	描述
error	ErrorInfo object	失败返回结构

**表11** ErrorInfo
参数	参数类型	描述
message	String	错误信息
code	String	错误码

状态码： 404

**表12** 响应Body参数
参数	参数类型	描述
error	ErrorInfo object	失败返回结构

**表13** ErrorInfo
参数	参数类型	描述
message	String	错误信息
code	String	错误码

状态码： 405

**表14** 响应Body参数
参数	参数类型	描述
error	ErrorInfo object	失败返回结构

**表15** ErrorInfo
参数	参数类型	描述
message	String	错误信息
code	String	错误码

状态码： 406

**表16** 响应Body参数
参数	参数类型	描述
error	ErrorInfo object	失败返回结构

**表17** ErrorInfo
参数	参数类型	描述
message	String	错误信息
code	String	错误码

状态码： 407

**表18** 响应Body参数
参数	参数类型	描述
error	ErrorInfo object	失败返回结构

**表19** ErrorInfo
参数	参数类型	描述
message	String	错误信息
code	String	错误码

状态码： 408

**表20** 响应Body参数
参数	参数类型	描述
error	ErrorInfo object	失败返回结构

**表21** ErrorInfo
参数	参数类型	描述
message	String	错误信息
code	String	错误码

状态码： 409

**表22** 响应Body参数
参数	参数类型	描述
error	ErrorInfo object	失败返回结构

**表23** ErrorInfo
参数	参数类型	描述
message	String	错误信息
code	String	错误码

状态码： 500

**表24** 响应Body参数
参数	参数类型	描述
error	ErrorInfo object	失败返回结构

**表25** ErrorInfo
参数	参数类型	描述
message	String	错误信息
code	String	错误码

状态码： 501

**表26** 响应Body参数
参数	参数类型	描述
error	ErrorInfo object	失败返回结构

**表27** ErrorInfo
参数	参数类型	描述
message	String	错误信息
code	String	错误码

状态码： 503

**表28** 响应Body参数
参数	参数类型	描述
error	ErrorInfo object	失败返回结构

**表29** ErrorInfo
参数	参数类型	描述
message	String	错误信息
code	String	错误码

状态码： 504

**表30** 响应Body参数
参数	参数类型	描述
error	ErrorInfo object	失败返回结构

**表31** ErrorInfo
参数	参数类型	描述
message	String	错误信息
code	String	错误码

请求示例

POST https://{endpoint}/v1/{project_id}/server-groups

{
  "server_group" : {
    "name" : "testname",
    "description" : "description",
    "source_availability_zone" : "cn-north-1a",
    "target_availability_zone" : "cn-north-1b",
    "domain_id" : "fb4bb8e3-a574-4437-a156-78c916aeea4d",
    "source_vpc_id" : "046852ef-c49d-409b-8389-546aaaa5701f",
    "dr_type" : "migration"
  }
}

响应示例

状态码： 200

{
  "job_id" : "0000000062db92d70162db9d200f000a"
}

状态码

状态码	描述
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
503	Service Unavailable
504	Gateway Timeout