文档首页/ 主机迁移服务 SMS/ API参考（联盟区域）/ API/ 配置设置管理/ 迁移任务配置设置
更新时间：2025-12-08 GMT+08:00
在线调试
CLI示例
查看PDF
分享

迁移任务配置设置

功能介绍

配置迁移任务特殊设置，例如配置指定同步的文件或路径

调用方法

请参见如何调用API。

URI

POST /v3/tasks/{task_id}/configuration-setting

表1 路径参数

参数

是否必选

参数类型

描述

task_id

是

String

任务id

最小长度：1

最大长度：36

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

最小长度：1

最大长度：16384
表3 请求Body参数

参数

是否必选

参数类型

描述

configurations

是

Array of ConfigBody objects

配置项列表

数组长度：0 - 10
表4 ConfigBody

参数

是否必选

参数类型

描述

config_key

是

String

配置类型

MIGRATE_EXCLUDE_DIR: 迁移时设定的不迁移目录

SYNC_EXCLUDE_DIR: 同步时设定的不同步目录

ONLY_SYNC_DIR: 同步时设定的同步目录

CONSISTENCY_DIR: 一致性校验的目录

CONSISTENCY_DIR_ILLEGAL: 一致性校验后非法目录

LINUX_BLOCK_COMPRESS_THREAD_NUM: linux块迁移压缩线程个数

MIGRATE_DST_IP: 迁移目的ip

LINUX_BLOCK_CACHE_SIZE: linux块迁移缓存大小

LINUX_CPU_LIMIT: linux的cpu限制

LINUX_MEM_LIMIT: linux的内存限制

LINUX_IO_LIMIT: linux的IO限制

NUM_PROCESS_MIGRATE: 迁移进程数

NUM_PROCESS_SYNC: 同步进程数

CONSISTENCY_RECHECK: 一致性校验再检

CONSISTENCY_MODE: 一致性校验模式

DYNAMIC_PORT: 动态端口

枚举值：

  • MIGRATE_EXCLUDE_DIR

  • SYNC_EXCLUDE_DIR

  • ONLY_SYNC_DIR

  • CONSISTENCY_DIR

  • CONSISTENCY_DIR_ILLEGAL

  • LINUX_BLOCK_COMPRESS_THREAD_NUM

  • MIGRATE_DST_IP

  • LINUX_BLOCK_CACHE_SIZE

  • LINUX_CPU_LIMIT

  • LINUX_MEM_LIMIT

  • LINUX_IO_LIMIT

  • NUM_PROCESS_MIGRATE

  • NUM_PROCESS_SYNC

  • CONSISTENCY_RECHECK

  • CONSISTENCY_MODE

  • DYNAMIC_PORT

config_value

是

String

具体配置参数字段，保存于数据库，最终在agent端进行解析

最小长度：0

最大长度：1024

config_status

否

String

描述配置状态的保留字段

最小长度：0

最大长度：255

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

-

String

上传相关配置成功

状态码：403

表6 响应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
表7 details

参数

参数类型

描述

error_code

String

SMS错误代码

最小长度：0

最大长度：65535

error_msg

String

SMS错误信息

最小长度：0

最大长度：65535

状态码：404

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：0

最大长度：255

error_msg

String

错误信息

最小长度：0

最大长度：1024

状态码：500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：0

最大长度：255

error_msg

String

错误信息

最小长度：0

最大长度：1024

请求示例

配置迁移任务特殊设置，配置任务是LINUX_CPU_LIMIT，限制值是50。

POST https://{endpoint}/v3/tasks/{task_id}/configuration-setting

{
  "configurations" : [ {
    "config_key" : "LINUX_CPU_LIMIT",
    "config_value" : 50
  } ]
}

响应示例

状态码：200

上传相关配置成功

{ }

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

鉴权失败

404

任务不存在

500

上传配置设置结果异常。

错误码

请参见错误码。

父主题： 配置设置管理