文档首页/主机迁移服务 SMS/API参考（阿布扎比区域）/API v3/迁移项目管理/更新迁移项目信息
更新时间：2025-02-13 GMT+08:00
在线调试
CLI示例
查看PDF
分享

更新迁移项目信息

功能介绍

更新迁移项目的信息。

调用方法

请参见如何调用API。

URI

PUT /v3/migprojects/{mig_project_id}

表1 路径参数

参数

是否必选

参数类型

描述

mig_project_id

是

String

迁移项目ID

最小长度：0

最大长度：255

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

X-Auth-Token

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

最小长度：1

最大长度：16384

表3 请求Body参数

参数

是否必选

参数类型

描述

id

否

String

迁移项目ID

最小长度：1

最大长度：254

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:文件级迁移

枚举值：

  • MIGRATE_BLOCK

  • MIGRATE_FILE

enterprise_project

否

String

企业项目名称

缺省值：default

最小长度：0

最大长度：255

syncing

是

Boolean

首次复制或者同步后 是否继续持续同步

缺省值：false

start_network_check

否

Boolean

是否启动网络质量检测

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

-

String

修改默认迁移项目信息成功

状态码：403

表5 响应Body参数

参数

参数类型

描述

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

表6 details

参数

参数类型

描述

error_code

String

SMS错误代码

最小长度：0

最大长度：65535

error_msg

String

SMS错误信息

最小长度：0

最大长度：65535

请求示例

修改ID为9879f7aa-3347-47fb-8f89-6070f9e0xxxx的迁移项目信息，新的迁移项目名称是225，region信息是region，限制速度为100M/s，迁移类型是MIGRATE_FILE文件级迁移

PUT  https://{endpoint}/v3/migprojects/9879f7aa-3347-47fb-8f89-6070f9e0xxxx

{
  "name" : 225,
  "region" : "region",
  "description" : "hello",
  "start_target_server" : true,
  "speed_limit" : 100,
  "use_public_ip" : true,
  "exist_server" : true,
  "type" : "MIGRATE_FILE",
  "syncing" : false
}

响应示例

状态码：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

鉴权失败

错误码

请参见错误码。

父主题：迁移项目管理