获取项目列表
功能介绍
主机迁移服务中可以使用迁移项目来对源端进行项目管理，使用该接口获取当前账户下所有的迁移项目列表。
调用方法
请参见如何调用API。
URI
GET /v3/migprojects
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
limit | 否 | Integer | 每一页记录的迁移项目 最小值：0 最大值：100 缺省值：50 |
offset | 否 | Integer | 偏移量 最小值：0 最大值：65535 缺省值：0 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | X-Auth-Token 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度：1 最大长度：16384 |
响应参数
状态码：200
参数 | 参数类型 | 描述 |
|---|---|---|
count | Integer | 查询到的迁移项目的数量 最小值：0 最大值：2147483647 |
migprojects | Array of MigprojectsResponseBody objects | 查询到的迁移项目详情 数组长度：0 - 65535 |
参数 | 参数类型 | 描述 |
|---|---|---|
id | String | 迁移项目ID 最小长度：1 最大长度：254 |
name | String | 迁移项目名称 最小长度：2 最大长度：19 |
use_public_ip | Boolean | 是否使用公网IP迁移 |
isdefault | Boolean | 是否为默认模板 |
start_target_server | Boolean | 迁移后是否启动目的端虚拟机 |
region | String | 区域名称 最小长度：0 最大长度：255 |
speed_limit | Integer | 模板中配置的限速信息，单位：Mbps 最小值：0 最大值：10000 |
exist_server | Boolean | 迁移项目下是否存在服务器 |
description | String | 迁移项目描述 最小长度：0 最大长度：255 |
type | String | 迁移项目默认迁移类型 MIGRATE_BLOCK:块级迁移 MIGRATE_FILE:文件级迁移 枚举值：
|
enterprise_project | String | 迁移项目所属的企业项目名称 最小长度：0 最大长度：255 |
syncing | Boolean | 是否持续同步 |
start_network_check | Boolean | 是否开启网络质量检测 |
状态码：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 |
请求示例
获取迁移项目列表
GET https://{endpoint}/v3/migprojects 响应示例
状态码：200
获取项目列表成功
{
"count" : 6,
"migprojects" : [ {
"id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"name" : "sms_test",
"use_public_ip" : true,
"isdefault" : true,
"start_target_server" : true,
"region" : "06334e957c80d2642f39c0030856abdb",
"speed_limit" : 0,
"exist_server" : true,
"description" : "",
"type" : "MIGRATE_BLOCK",
"enterprise_project" : "default"
}, {
"id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"name" : "SystemProject",
"use_public_ip" : true,
"isdefault" : false,
"start_target_server" : true,
"region" : "region",
"speed_limit" : 0,
"exist_server" : true,
"description" : "",
"type" : "MIGRATE_BLOCK",
"enterprise_project" : "default"
}, {
"id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"name" : "sms_test",
"use_public_ip" : true,
"isdefault" : false,
"start_target_server" : true,
"region" : "region",
"speed_limit" : 0,
"exist_server" : true,
"description" : "",
"type" : "MIGRATE_BLOCK",
"enterprise_project" : "default"
}, {
"id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"name" : "sms_test_Test",
"use_public_ip" : true,
"isdefault" : false,
"start_target_server" : true,
"region" : "region",
"speed_limit" : 0,
"exist_server" : true,
"description" : "",
"type" : "MIGRATE_BLOCK",
"enterprise_project" : "default"
}, {
"id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"name" : "sms_test002",
"use_public_ip" : true,
"isdefault" : false,
"start_target_server" : true,
"region" : "region",
"speed_limit" : 0,
"exist_server" : true,
"description" : "",
"type" : "MIGRATE_BLOCK",
"enterprise_project" : "default"
}, {
"id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"name" : "sms_test003",
"use_public_ip" : true,
"isdefault" : false,
"start_target_server" : true,
"region" : "region",
"speed_limit" : 0,
"exist_server" : true,
"description" : "",
"type" : "MIGRATE_BLOCK",
"enterprise_project" : "default"
} ]
} 状态码：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 | 鉴权失败 |
错误码
请参见错误码。
