新建迁移项目
功能介绍
新建迁移项目。
接口约束
迁移项目不可与已有的迁移项目同名。
调用方法
请参见如何调用API。
URI
POST /v3/migprojects
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | X-Auth-Token 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:16384 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 是 | String | 迁移项目名称 最小长度:2 最大长度:19 |
| description | 否 | String | 迁移项目描述 最小长度:0 最大长度:255 |
| isdefault | 否 | Boolean | 是否为默认模板 缺省值:false |
| region | 是 | String | 区域名称 最小长度:0 最大长度:255 |
| start_target_server | 否 | Boolean | 迁移后是否启动目的端虚拟机 缺省值:true |
| speed_limit | 否 | Integer | 限制迁移速率,单位:Mbps 最小值:0 最大值:10000 |
| use_public_ip | 是 | Boolean | 是否使用公网IP迁移 缺省值:true |
| exist_server | 是 | Boolean | 是否是已经存在的服务器 缺省值:true |
| type | 是 | String | 迁移项目类型 MIGRATE_BLOCK:块级迁移 MIGRATE_FILE:文件级迁移 最小长度:0 最大长度:255 枚举值:
|
| enterprise_project | 否 | String | 企业项目名称 缺省值:default 最小长度:0 最大长度:255 |
| syncing | 是 | Boolean | 首次复制或者同步后 是否继续持续同步 缺省值:false |
| start_networck_check | 否 | Boolean | 是否启动网络质量检测 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 创建迁移项目返回的新添加的迁移项目的id 最小长度:0 最大长度:255 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误代码 最小长度:0 最大长度:255 |
| error_msg | String | 错误信息 最小长度:0 最大长度:255 |
| encoded_authorization_message | String | 加密授权信息 最小长度:0 最大长度:65535 |
| error_param | Array of strings | 错误参数 最小长度:0 最大长度:65535 数组长度:1 - 20 |
| details | Array of details objects | 详细错误信息 数组长度:1 - 20 |
请求示例
新建迁移项目。新的迁移项目名称是N121,region信息是region,使用公网ip是true,迁移项目类型是MIGRATE_BLOCK
POST https://{endpoint}/v3/migprojects
{
"name" : "N121",
"description" : "",
"region" : "region",
"start_target_server" : true,
"speed_limit" : 0,
"use_public_ip" : true,
"exist_server" : true,
"isdefault" : true,
"type" : "MIGRATE_BLOCK",
"syncing" : false,
"enterprise_project" : "default"
} 响应示例
状态码:200
新建迁移项目成功
{
"id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001"
} 状态码:403
鉴权失败
{
"error_code" : "SMS.9004",
"error_msg" : "The current account does not have the permission to execute policy You do not have permission to perform action XXX on resource XXX.",
"encoded_authorization_message" : "XXXXXX",
"error_param" : [ "You do not have permission to perform action XXX on resource XXX." ],
"details" : [ {
"error_code" : "SMS.9004",
"error_msg" : "You do not have permission to perform action XXX on resource XXX."
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 新建迁移项目成功 |
| 403 | 鉴权失败 |
错误码
请参见错误码。