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

上报源端服务器基本信息

功能介绍

上报源端服务器信息,上报成功后会在sms服务器列表中看到对应的源端服务器信息。

URI

POST /v3/sources

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

最小长度:1

最大长度:16384

表2 请求Body参数

参数

是否必选

参数类型

描述

id

String

源端在SMS数据库中的ID

最小长度:0

最大长度:255

ip

String

源端服务器ip,注册源端时必选,更新非必选

最小长度:0

最大长度:255

name

String

用来区分不同源端服务器的名称

最小长度:0

最大长度:255

hostname

String

源端主机名,注册源端必选,更新非必选

最小长度:0

最大长度:255

os_type

String

源端服务器的OS类型,分为Windows和Linux,注册必选,更新非必选

最小长度:0

最大长度:255

枚举值:

  • WINDOWS
  • LINUX

os_version

String

操作系统版本,注册必选,更新非必选

最小长度:0

最大长度:255

firmware

String

源端服务器启动类型,如BIOS或者UEFI

最小长度:0

最大长度:255

枚举值:

  • BIOS
  • UEFI

cpu_quantity

Integer

CPU个数,单位vCPU

最小值:0

最大值:65535

memory

Long

内存大小,单位MB

最小值:0

最大值:9223372036854775807

disks

Array of ServerDisk objects

源端服务器的磁盘信息

btrfs_list

Array of BtrfsFileSystem objects

Linux 必选,源端的Btrfs信息。如果源端不存在Btrfs,则为[]

networks

Array of NetWork objects

源端服务器的网卡信息

domain_id

String

租户的domainId

最小长度:0

最大长度:255

has_rsync

Boolean

是否安装rsync组件,Linux系统此参数为必选

paravirtualization

Boolean

Linux场景必选,源端是否是半虚拟化

raw_devices

String

Linux必选,裸设备列表

最小长度:0

最大长度:255

driver_files

Boolean

Windows 必选,是否缺少驱动文件

system_services

Boolean

Windows必选,是否存在不正常服务

account_rights

Boolean

Windows必选,权限是否满足要求

boot_loader

String

Linux必选,系统引导类型,BOOT_LOADER(GRUB/LILO)

枚举值:

  • GRUB
  • LILO

system_dir

String

Windows必选,系统目录

最小长度:0

最大长度:255

volume_groups

Array of VolumeGroups objects

Linux必选,如果没有卷组,输入[]

agent_version

String

Agent版本

最小长度:0

最大长度:255

表3 ServerDisk

参数

是否必选

参数类型

描述

name

String

磁盘名称

最小长度:0

最大长度:255

partition_style

String

磁盘的分区类型,添加源端时源端磁盘必选

枚举值:

  • MBR
  • GPT

device_use

String

磁盘类型

枚举值:

  • BOOT
  • OS

size

Long

磁盘总大小,以字节为单位

最小值:0

最大值:9223372036854775807

used_size

Long

磁盘已使用大小,以字节为单位

最小值:0

最大值:9223372036854775807

physical_volumes

Array of PhysicalVolume objects

磁盘上的物理分区信息

os_disk

Boolean

是否为系统盘

relation_name

String

Linux系统 目的端ECS中与源端关联的磁盘名称

最小长度:0

最大长度:255

表4 PhysicalVolume

参数

是否必选

参数类型

描述

device_use

String

分区类型,普通分区,启动分区,系统分区

最小长度:0

最大长度:255

file_system

String

文件系统类型

最小长度:0

最大长度:255

index

Integer

顺序

最小值:0

最大值:2147483647

mount_point

String

挂载点

最小长度:0

最大长度:255

name

String

名称,windows表示盘符,Linux表示设备号

最小长度:0

最大长度:255

size

Long

大小

最小值:0

最大值:9223372036854775807

used_size

Long

使用大小

最小值:0

最大值:9223372036854775807

uuid

String

GUID,可从源端查询

最小长度:0

最大长度:255

size_per_cluster

Integer

每个cluster大小

最小值:0

最大值:2147483647

表5 BtrfsFileSystem

参数

是否必选

参数类型

描述

name

String

文件系统名称

最小长度:0

最大长度:255

label

String

文件系统标签,若无标签为空字符串

最小长度:0

最大长度:255

uuid

String

文件系统的uuid

最小长度:0

最大长度:255

device

String

btrfs包含的设备名称

最小长度:0

最大长度:255

size

Long

文件系统数据占用大小

最小值:0

最大值:9223372036854775807

nodesize

Long

btrfs节点大小

最小值:0

最大值:9223372036854775807

sectorsize

Integer

扇区大小

最小值:0

最大值:2147483647

data_profile

String

数据配置(RAD)

最小长度:0

最大长度:255

system_profile

String

文件系统配置(RAD)

最小长度:0

最大长度:255

metadata_profile

String

元数据配置(RAD)

最小长度:0

最大长度:255

global_reserve1

String

Btrfs文件系统信息

最小长度:0

最大长度:255

g_vol_used_size

Long

Btrfs卷已使用空间大小

最小值:0

最大值:9223372036854775807

default_subvolid

String

默认子卷ID

最小长度:0

最大长度:255

default_subvol_name

String

默认子卷名称

最小长度:0

最大长度:255

default_subvol_mountpath

String

默认子卷挂载路径/BTRFS文件系统的挂载路径

最小长度:0

最大长度:255

subvolumn

Array of BtrfsSubvolumn objects

子卷信息

表6 BtrfsSubvolumn

参数

是否必选

参数类型

描述

uuid

String

父卷的uuid

最小长度:0

最大长度:255

is_snapshot

String

子卷是否为快照

最小长度:0

最大长度:255

subvol_id

String

子卷的id

最小长度:0

最大长度:255

parent_id

String

父卷id

最小长度:0

最大长度:255

subvol_name

String

子卷的名称

最小长度:0

最大长度:255

subvol_mount_path

String

子卷的挂载路径

最小长度:0

最大长度:255

表7 NetWork

参数

是否必选

参数类型

描述

name

String

网卡的名称

最小长度:0

最大长度:255

ip

String

该网卡绑定的IP

最小长度:0

最大长度:255

netmask

String

掩码

最小长度:0

最大长度:255

gateway

String

网关

最小长度:0

最大长度:255

mtu

Integer

Linux必选,网卡的MTU

最小值:0

最大值:2147483647

mac

String

Mac地址

最小长度:0

最大长度:255

id

String

数据库Id

最小长度:0

最大长度:255

表8 VolumeGroups

参数

是否必选

参数类型

描述

components

String

Pv信息

最小长度:0

最大长度:255

free_size

Long

剩余空间

最小值:0

最大值:9223372036854775807

logical_volumes

Array of LogicalVolumes objects

lv信息

name

String

名称

最小长度:0

最大长度:255

size

Long

大小

最小值:0

最大值:9223372036854775807

表9 LogicalVolumes

参数

是否必选

参数类型

描述

block_count

Integer

块数量

最小值:0

最大值:4294967296

缺省值:0

block_size

Long

块大小

最小值:0

最大值:1048576

缺省值:0

file_system

String

文件系统

最小长度:0

最大长度:255

inode_size

Integer

inode数量

最小值:0

最大值:4294967296

mount_point

String

挂载点

最小长度:0

最大长度:256

name

String

名称

最小长度:0

最大长度:1024

size

Long

大小

最小值:0

最大值:9223372036854775807

used_size

Long

使用大小

最小值:0

最大值:9223372036854775807

free_size

Long

剩余空间

最小值:0

最大值:9223372036854775807

响应参数

状态码: 200

表10 响应Body参数

参数

参数类型

描述

id

String

源端id

最小长度:0

最大长度:255

请求示例

安装在源端服务器上的迁移Agent调用此接口,当安装在源端服务器上的迁移Agent完成基本信息搜集后,调用该接口将基本信息上报到SMS服务端。

POST https://{endpoint}/v3/sources

{
  "os_type" : "LINUX",
  "name" : "host-192-168-136-161",
  "os_version" : "SUSE12_64BIT_SP2",
  "linux_block_check" : "{\"release_type\": \"SUSE\", \"release_version\": \"12.2\", \"kernel_simplification\": \"4.4.21\", \"architecture\": \"x86_64\", \"kernel_version\": \"4.4.21-69-default\"}",
  "kernel_version" : "4.4.21-69-default",
  "virtualization_type" : "HVM",
  "paravirtualization" : true,
  "firmware" : "BIOS",
  "has_rsync" : true,
  "boot_loader" : "GRUB",
  "disks" : [ {
    "name" : "/dev/vda",
    "device_use" : "BOOT",
    "size" : 42949672960,
    "partition_style" : "MBR",
    "used_size" : 42948624384,
    "physical_volumes" : [ {
      "name" : "/dev/vda1",
      "size" : 2153775104,
      "device_use" : "NORMAL",
      "used_size" : 2153775104,
      "inode_size" : 0,
      "file_system" : "swap",
      "mount_point" : ""
    }, {
      "name" : "/dev/vda2",
      "size" : 16862150656,
      "device_use" : "BTRFS",
      "used_size" : 16862150656,
      "inode_size" : 0,
      "file_system" : "btrfs",
      "mount_point" : ""
    }, {
      "name" : "/dev/vda3",
      "size" : 23932698624,
      "device_use" : "NORMAL",
      "used_size" : 33988608,
      "inode_size" : 0,
      "file_system" : "xfs",
      "mount_point" : "/home"
    } ]
  }, {
    "name" : "/dev/vdb",
    "device_use" : "NORMAL",
    "size" : 21474836480,
    "partition_style" : "MBR",
    "used_size" : 21473787904,
    "physical_volumes" : [ {
      "name" : "/dev/vdb1",
      "size" : 21473787904,
      "device_use" : "VOLUME_GROUP",
      "used_size" : 21473787904,
      "inode_size" : 0,
      "file_system" : "LVM2_member",
      "mount_point" : ""
    } ]
  }, {
    "name" : "/dev/vdc",
    "device_use" : "VOLUME_GROUP",
    "size" : 21474836480,
    "partition_style" : "MBR",
    "used_size" : 0,
    "physical_volumes" : [ ]
  } ],
  "volume_groups" : [ {
    "name" : "vg1",
    "size" : 42948624384,
    "components" : "/dev/vdb1;/dev/vdc",
    "logical_volumes" : [ {
      "name" : "/dev/mapper/vg1-lv1",
      "device_use" : "NORMAL",
      "size" : 10737418240,
      "free_size" : 10713837568,
      "used_size" : 23580672,
      "file_system" : "ext4",
      "mount_point" : "/mnt/lv1",
      "inode_size" : "256"
    } ]
  } ],
  "btrfs_list" : [ {
    "name" : "/dev/vda2",
    "label" : "none",
    "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4",
    "device" : "/dev/vda2",
    "size" : "3.30GiB",
    "nodesize" : "16384",
    "sectorsize" : "4096",
    "data_profile" : "single",
    "system_profile" : "single",
    "metadata_profile" : "single",
    "global_reserve1" : "single",
    "g_vol_used_size" : "3894038528",
    "default_subvolid" : "259",
    "default_subvol_name" : "@/.snapshots/1/snapshot",
    "default_subvol_mountpath" : "/",
    "subvolumn" : [ {
      "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4",
      "is_snapshot" : "false",
      "subvol_id" : "257",
      "parent_id" : "5",
      "subvol_name" : "@",
      "subvol_mount_path" : "null"
    }, {
      "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4",
      "is_snapshot" : "false",
      "subvol_id" : "258",
      "parent_id" : "257",
      "subvol_name" : "@/.snapshots",
      "subvol_mount_path" : "/.snapshots"
    }, {
      "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4",
      "is_snapshot" : "true",
      "subvol_id" : "259",
      "parent_id" : "258",
      "subvol_name" : "@/.snapshots/1/snapshot",
      "subvol_mount_path" : "/"
    }, {
      "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4",
      "is_snapshot" : "false",
      "subvol_id" : "260",
      "parent_id" : "257",
      "subvol_name" : "@/boot/grub2/i386-pc",
      "subvol_mount_path" : "/boot/grub2/i386-pc"
    }, {
      "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4",
      "is_snapshot" : "false",
      "subvol_id" : "261",
      "parent_id" : "257",
      "subvol_name" : "@/boot/grub2/x86_64-efi",
      "subvol_mount_path" : "/boot/grub2/x86_64-efi"
    }, {
      "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4",
      "is_snapshot" : "false",
      "subvol_id" : "262",
      "parent_id" : "257",
      "subvol_name" : "@/opt",
      "subvol_mount_path" : "/opt"
    }, {
      "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4",
      "is_snapshot" : "false",
      "subvol_id" : "263",
      "parent_id" : "257",
      "subvol_name" : "@/srv",
      "subvol_mount_path" : "/srv"
    }, {
      "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4",
      "is_snapshot" : "false",
      "subvol_id" : "264",
      "parent_id" : "257",
      "subvol_name" : "@/tmp",
      "subvol_mount_path" : "/tmp"
    }, {
      "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4",
      "is_snapshot" : "false",
      "subvol_id" : "265",
      "parent_id" : "257",
      "subvol_name" : "@/usr/local",
      "subvol_mount_path" : "/usr/local"
    }, {
      "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4",
      "is_snapshot" : "false",
      "subvol_id" : "266",
      "parent_id" : "257",
      "subvol_name" : "@/var/cache",
      "subvol_mount_path" : "/var/cache"
    }, {
      "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4",
      "is_snapshot" : "false",
      "subvol_id" : "267",
      "parent_id" : "257",
      "subvol_name" : "@/var/crash",
      "subvol_mount_path" : "/var/crash"
    }, {
      "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4",
      "is_snapshot" : "false",
      "subvol_id" : "268",
      "parent_id" : "257",
      "subvol_name" : "@/var/lib/libvirt/images",
      "subvol_mount_path" : "/var/lib/libvirt/images"
    }, {
      "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4",
      "is_snapshot" : "false",
      "subvol_id" : "269",
      "parent_id" : "257",
      "subvol_name" : "@/var/lib/machines",
      "subvol_mount_path" : "/var/lib/machines"
    }, {
      "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4",
      "is_snapshot" : "false",
      "subvol_id" : "270",
      "parent_id" : "257",
      "subvol_name" : "@/var/lib/mailman",
      "subvol_mount_path" : "/var/lib/mailman"
    }, {
      "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4",
      "is_snapshot" : "false",
      "subvol_id" : "271",
      "parent_id" : "257",
      "subvol_name" : "@/var/lib/mariadb",
      "subvol_mount_path" : "/var/lib/mariadb"
    }, {
      "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4",
      "is_snapshot" : "false",
      "subvol_id" : "272",
      "parent_id" : "257",
      "subvol_name" : "@/var/lib/mysql",
      "subvol_mount_path" : "/var/lib/mysql"
    }, {
      "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4",
      "is_snapshot" : "false",
      "subvol_id" : "273",
      "parent_id" : "257",
      "subvol_name" : "@/var/lib/named",
      "subvol_mount_path" : "/var/lib/named"
    }, {
      "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4",
      "is_snapshot" : "false",
      "subvol_id" : "274",
      "parent_id" : "257",
      "subvol_name" : "@/var/lib/pgsql",
      "subvol_mount_path" : "/var/lib/pgsql"
    }, {
      "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4",
      "is_snapshot" : "false",
      "subvol_id" : "275",
      "parent_id" : "257",
      "subvol_name" : "@/var/log",
      "subvol_mount_path" : "/var/log"
    }, {
      "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4",
      "is_snapshot" : "false",
      "subvol_id" : "276",
      "parent_id" : "257",
      "subvol_name" : "@/var/opt",
      "subvol_mount_path" : "/var/opt"
    }, {
      "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4",
      "is_snapshot" : "false",
      "subvol_id" : "277",
      "parent_id" : "257",
      "subvol_name" : "@/var/spool",
      "subvol_mount_path" : "/var/spool"
    }, {
      "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4",
      "is_snapshot" : "false",
      "subvol_id" : "278",
      "parent_id" : "257",
      "subvol_name" : "@/var/tmp",
      "subvol_mount_path" : "/var/tmp"
    }, {
      "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4",
      "is_snapshot" : "true",
      "subvol_id" : "282",
      "parent_id" : "258",
      "subvol_name" : "@/.snapshots/2/snapshot",
      "subvol_mount_path" : "null"
    } ]
  } ],
  "cpu_quantity" : 1,
  "memory" : 934752256,
  "networks" : [ {
    "name" : "eth0",
    "ip" : "192.168.136.161",
    "mac" : "1a9660eb8a3ffcf4df6d7865b52eb54f7b0cd194029e0eadd8e2c7f1267d80c0"
  } ],
  "ip" : "192.168.136.161",
  "agent_version" : "2.2.1"
}

响应示例

状态码: 200

源端注册成功

{
  "id" : "8abda8635e09d185015e09d188dd0001xx"
}

状态码

状态码

描述

200

源端注册成功

错误码

请参见错误码