更新时间:2022-08-05 GMT+08:00

获取项目列表

功能介绍

主机迁移服务中可以使用迁移项目来对源端进行项目管理,使用该接口获取当前账户下所有的迁移项目列表。

URI

GET /v3/migprojects

表1 Query参数

参数

是否必选

参数类型

描述

limit

Integer

每一页记录的迁移项目

最小值:0

最大值:100

缺省值:50

offset

Integer

偏移量

最小值:0

最大值:65535

缺省值:0

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:1

最大长度:16384

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

count

Integer

查询到的迁移项目的数量

最小值:0

最大值:2147483647

migprojects

Array of MigprojectsResponseBody objects

查询到的迁移项目详情

表4 MigprojectsResponseBody

参数

参数类型

描述

id

String

迁移项目ID

最小长度:0

最大长度:255

name

String

迁移项目名称

最小长度:0

最大长度:255

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

是否持续同步

请求示例

获取迁移项目列表

GET https://{endpoint}/v3/migprojects

响应示例

状态码: 200

获取项目列表成功

{
  "count" : 6,
  "migprojects" : [ {
    "id" : "58005530-57a4-4589-85dd-69c7ca1bba17",
    "name" : "sms_test",
    "use_public_ip" : true,
    "isdefault" : true,
    "start_target_server" : true,
    "region" : "06334e957c80d2642f39c0030856abdb",
    "speed_limit" : 0,
    "exist_server" : true,
    "description" : "",
    "template" : null,
    "type" : "MIGRATE_BLOCK",
    "enterprise_project" : "defalut"
  }, {
    "id" : "f7edd6c0-7faf-4e1a-8c0b-0bb4b53d162a",
    "name" : "SystemProject",
    "use_public_ip" : true,
    "isdefault" : false,
    "start_target_server" : true,
    "region" : "region",
    "speed_limit" : 0,
    "exist_server" : true,
    "description" : "",
    "template" : null,
    "type" : "MIGRATE_BLOCK",
    "enterprise_project" : "defalut"
  }, {
    "id" : "8dd46a53-c7a6-42c4-98fb-9d140a1f3ac4",
    "name" : "sms_test",
    "use_public_ip" : true,
    "isdefault" : false,
    "start_target_server" : true,
    "region" : "region",
    "speed_limit" : 0,
    "exist_server" : true,
    "description" : "",
    "template" : null,
    "type" : "MIGRATE_BLOCK",
    "enterprise_project" : "defalut"
  }, {
    "id" : "ee35f0bf-6398-494f-a45c-7825e1499840",
    "name" : "sms_test_Test",
    "use_public_ip" : true,
    "isdefault" : false,
    "start_target_server" : true,
    "region" : "region",
    "speed_limit" : 0,
    "exist_server" : true,
    "description" : "",
    "template" : null,
    "type" : "MIGRATE_BLOCK",
    "enterprise_project" : "defalut"
  }, {
    "id" : "9ed854a4-c294-449c-9169-2c70d611bfc9",
    "name" : "sms_test002",
    "use_public_ip" : true,
    "isdefault" : false,
    "start_target_server" : true,
    "region" : "region",
    "speed_limit" : 0,
    "exist_server" : true,
    "description" : "",
    "template" : null,
    "type" : "MIGRATE_BLOCK",
    "enterprise_project" : "defalut"
  }, {
    "id" : "feba29f4-e9a2-4d22-b4bb-9e89a29600ab",
    "name" : "sms_test003",
    "use_public_ip" : true,
    "isdefault" : false,
    "start_target_server" : true,
    "region" : "region",
    "speed_limit" : 0,
    "exist_server" : true,
    "description" : "",
    "template" : null,
    "type" : "MIGRATE_BLOCK",
    "enterprise_project" : "defalut"
  } ]
}

状态码

状态码

描述

200

获取项目列表成功

错误码

请参见错误码