创建保护实例
功能介绍
创建保护实例。保护实例创建完成后，系统默认容灾站点云服务器名称与生产站点云服务器名称相同，但ID不同。如果需要修改云服务器名称，请在保护实例详情页面单击云服务器名称，进入云服务器详情页面进行修改，可参考更新保护实例名称接口。
约束与限制
- 保护组的状态为available或者protected。
- 生产站点服务器不能挂载共享云硬盘，如需使用挂载了共享云硬盘的服务器创建保护实例请使用批量创建保护实例接口。
- 每个服务器只能创建一个保护实例
- 云服务器必须与保护组在同一个VPC。
- 由弹性伸缩组伸缩时所创建的云服务器，在对该云服务器做容灾保护后，当弹性伸缩组缩容时，不支持对该云服务器执行删除操作。
- 创建保护实例时，如果生产站点服务器为Windows云服务器且设置为密钥方式登录，请确保生产站点服务器使用的密钥对存在，否则可能导致云平台无法创建容灾站点云服务器，从而导致创建保护实例失败
如果生产站点云服务器对应的密钥对已被删除，请重新创建相同名称的密钥对。
- 创建保护实例时，选择的生产站点云服务器如果加入了企业项目，保护实例创建成功后，容灾站点云服务器不会自动加入企业项目，如有需要请手动将容灾站点云服务器加入到企业项目。
- 创建保护实例完成并对生产站点的服务器做容灾保护后，生产站点服务器中的“主机名”、“名称”、“安全组”、“委托”、“云服务器组”、“标签”和“自动恢复”配置项修改不会再自动同步到容灾站点的服务器上。您可以在控制台页面上手动将这些配置项的修改添加到容灾站点的服务器上。
- 创建保护实例时，如果生产站点云服务器已经被添加到云服务器组中，则不支持指定专属主机创建容灾站点云服务器。
URI
- URI格式
- 参数说明
参数名称
是否必选
参数类型
说明
project_id
是
String
项目ID。
获取方法请参见获取项目ID。
请求消息
- 参数说明
参数名称
是否必选
参数类型
说明
protected_instance
是
Object
保护实例的信息。
详情请参见表1。
表1 protected_instance字段说明 参数名称
是否必选
参数类型
说明
server_group_id
是
String
需要加入的保护组ID。
具体信息可参考查询保护组列表接口。
server_id
是
String
指定的生产站点云服务器ID。
说明：接口调用成功后，容灾站点云服务器会自动创建。
name
是
String
指定保护实例的名称，最大支持长度为64个字节。只包含中文字符、英文字母（a～ｚ、Ａ～Ｚ）、数字（０~９）、小数点（．）、下划线（_）、中划线（-）。
description
否
String
指定保护实例的描述，最大支持长度为64个字节。不能包含左尖括号（<）或右尖括号（>）。
cluster_id
否
String
专属分布式存储池ID。
当容灾站点磁盘选择专属分布式存储时指定该字段。
primary_subnet_id
否
String
容灾站点云服务器主网卡所在子网的“网络ID”，与通过VPC的API接口查询到的“neutron_network_id”字段值一致。
primary_ip_address
否
String
容灾站点云服务器主网卡IP地址。
此参数仅在传入primary_subnet_id时有效。
指定primary_subnet_id时，如果不指定该参数，将自动分配容灾站点云服务器主网卡IP地址。
flavorRef
否
String
指定的容灾站点云服务器的flavor ID。
说明：- 不指定此参数时，容灾站点云服务器的flavor ID默认和生产站点云服务器保持一致。
- 不同规格的云服务器在性能上存在差异，可能会对云服务器上运行的应用产生影响。为保证切换/故障切换后云服务器的性能，建议容灾站点服务器的规格（CPU、内存）不低于生产站点云服务器的规格（CPU、内存）。
tenancy
否
String
在专属主机或共享池中创建容灾站点云服务器，默认为在共享池中创建。
值为：shared或dedicated。
shared：表示共享池。
dedicated：表示专属主机。
dedicated_host_id
否
String
专属主机id，此属性仅在tenancy值为dedicated时有效。
若不指定此属性，系统将自动分配租户可以自动放置弹性云服务器的专属主机。
tags
否
Array of objects
标签列表。
详情请参见表2。
说明：创建保护实例时，一个保护实例最多可以添加10个标签。
- 请求样例
POST https://{Endpoint}/v1/{project_id}/protected-instances
{ "protected_instance":{ "server_group_id": "523ab8ad-3759-4933-9436-4cf4ebb20867", "server_id": "403b603d-1d91-42cc-a357-81f3c2daf43f", "name": "test_protected_instance_name", "description": "my description", "primary_subnet_id": "a32217fh-3413-c313-6342-3124d3491502", "primary_ip_address": "192.168.0.5", "flavorRef": "s3.large.2", "tenancy": "dedicated", "dedicated_host_id": "0bc41598-1b5a-4bd2-872a-82e6abb82e68", } }
响应
- 要素说明
参数名称
参数类型
说明
job_id
String
执行异步API命令下发成功的返回参数，任务执行结果请参考查询job状态接口。
- 响应样例
{ "job_id": "0000000062db92d70162db9d200f00bb" }或
{ "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
网关超时。
