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

查询配置资源

功能介绍

使用该接口查询指定任务的指定配置类型的配置信息

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

task_id

是

String

任务id

最小长度：1

最大长度：36
表2 Query参数

参数

是否必选

参数类型

描述

config_key

否

String

具体请求配置项

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

最小长度：1

最大长度：16384

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

task_id

String

任务ID

最小长度：0

最大长度：100

migrate_type

String

迁移类型

WINDOWS_MIGRATE_BLOCK: windows块级迁移

LINUX_MIGRATE_FILE: linux文件级迁移

LINUX_MIGRATE_BLOCK: linux块级迁移

枚举值：

  • WINDOWS_MIGRATE_BLOCK

  • LINUX_MIGRATE_FILE

  • LINUX_MIGRATE_BLOCK

configurations

Array of ConfigBody objects

配置项的具体配置信息

数组长度：0 - 1000
表5 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

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：0

最大长度：255

error_msg

String

错误信息

最小长度：0

最大长度：1024

状态码：403

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

参数

参数类型

描述

error_code

String

SMS错误代码

最小长度：0

最大长度：65535

error_msg

String

SMS错误信息

最小长度：0

最大长度：65535

状态码：404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：0

最大长度：255

error_msg

String

错误信息

最小长度：0

最大长度：1024

状态码：500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：0

最大长度：255

error_msg

String

错误信息

最小长度：0

最大长度：1024

请求示例

获取指定任务0867ef5f3xxxxxxxxxxxxxxx关于MIGRATE_EXCLUDE_PATH的所有配置信息

GET https://{endpoint}/v3/tasks/0867ef5f3xxxxxxxxxxxxxxx/configuration-setting?config_key=MIGRATE_EXCLUDE_PATH

响应示例

状态码：200

查询配置资源成功

{
  "task_id" : "0867ef5f3xxxxxxxxxxxxxxx",
  "migrate_type" : "LINUX_FILE_MIGRATE",
  "configurations" : [ {
    "config_key" : "MIGRATE_EXCLUDE_PATH",
    "config_value" : "/test",
    "config_status" : ""
  } ]
}

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

查询配置资源成功

400

Bad Request

403

鉴权失败

404

请求任务不存在

500

请求配置异常

错误码

请参见错误码。

父主题： 配置设置管理