更新时间:2023-11-21 GMT+08:00

创建保护组

功能介绍

创建保护组。

本接口为异步接口,调用成功只是表示请求下发,创建结果需要通过查询job状态接口获取。

约束与限制

URI

  • URI格式

    POST /v1/{project_id}/server-groups

  • 参数说明

    参数名称

    是否必选

    参数类型

    说明

    project_id

    String

    项目ID。

    获取方法请参见获取项目ID

请求消息

  • 参数说明

    参数名称

    是否必选

    参数类型

    说明

    server_group

    Object

    保护组信息。

    详情请参见表1

    表1 server_group字段说明

    参数名称

    是否必选

    参数类型

    说明

    name

    String

    指定保护组的名称,最大支持长度为64个字节。只包含中文字符、英文字母(a~z、A~Z)、数字(0~9)、小数点(.)、下划线(_)、中划线(-)。

    description

    String

    指定保护组的描述,最大支持长度为64个字节。不能包含左尖括号(<)或右尖括号(>)。

    source_availability_zone

    String

    指定保护组的生产站点可用区名称。

    可以通过查询双活域接口查询。

    target_availability_zone

    String

    指定保护组的容灾站点可用区名称。

    可以通过查询双活域接口查询。

    domain_id

    String

    指定双活域的ID。

    可以通过查询双活域接口查询。

    source_vpc_id

    String

    生产站点虚拟私有云ID。

    dr_type

    String

    部署模式。默认值为“migration”,migration表示VPC内迁移。

  • 请求样例
    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",
                    
    	} 
    }

响应

  • 要素说明

    参数名称

    参数类型

    说明

    job_id

    String

    任务ID。

    执行异步API命令下发成功的返回参数,任务执行结果请参考查询job状态接口。

  • 响应样例
    { 
       "job_id": "0000000062db92d70162db9d200f000a" 
     }

    { 
         "error": { 
             "message": "XXXX",  
             "code": "XXX" 
         } 
     }

    其中error是泛指的错误,有badrequest、itemNotFound等,如报错为:

    { 
         "badrequest": { 
             "message": "XXXX",  
             "code": "XXX" 
         } 
     }

返回值

  • 正常

    返回值

    说明

    200

    服务器已接受请求。

  • 异常

    返回值

    说明

    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

    请求未完成。服务器不支持所请求的功能。

    502 Bad Gateway

    请求未完成。服务器从上游服务器收到一个无效的响应。

    503 Service Unavailable

    请求未完成。系统暂时异常。

    504 Gateway Timeout

    网关超时。