API v3_主机迁移服务 SMS_API参考_华为云

(1)

API 参考

文档版本 12

发布日期 2021-11-26

(2)

非经本公司书面许可，任何单位和个人不得擅自摘抄、复制本文档内容的部分或全部，并不得以任何形式传播。

商标声明

和其他华为商标均为华为技术有限公司的商标。

本文档提及的其他所有商标或注册商标，由各自的所有人拥有。

注意

您购买的产品、服务或特性等应受华为公司商业合同和条款的约束，本文档中描述的全部或部分产品、服务或特性可能不在您的购买或使用范围之内。除非合同另有约定，华为公司对本文档内容不做任何明示或暗示的声明或保证。

由于产品版本升级或其他原因，本文档内容会不定期进行更新。除非另有约定，本文档仅作为使用指导，本文档中的所有陈述、信息和建议不构成任何明示或暗示的担保。

(3)

1 ^{使用前必读}

1.1 概述

欢迎使用主机迁移服务（Server Migration Service）。主机迁移服务是一种P2V/V2V 迁移服务，可以帮您把X86物理服务器或者私有云、公有云平台上的虚拟机迁移到华为云弹性云服务器上，从而帮助您轻松地把服务器上的应用和数据迁移到华为云。

您可以使用本文档提供的API对主机迁移服务进行相关操作，如创建、删除、查询等。

支持的全部操作请参见API概览。

在调用主机迁移服务API之前，请确保已经充分了解主机迁移服务相关概念，详细信息请参见产品介绍。

1.2 调用说明

主机迁移服务提供了REST（Representational State Transfer）风格API，支持您通过 HTTPS请求调用，调用方法请参见如何调用API。

1.3 终端节点

终端节点（Endpoint）即调用API的请求地址，不同服务不同区域的终端节点不同，您可以从地区和终端节点中查询主机迁移服务的终端节点。

主机迁移服务的终端节点如下表所示，请您根据业务需要选择对应区域的终端节点。

表1-1 主机迁移服务的终端节点

区域名称区域终端节点（Endpoint）

华北-北京一 cn-north-1 sms.cn-north-1.myhuaweicloud.com 中国-香港 ap-

southeast-1 sms.ap-southeast-1.myhuaweicloud.com

(6)

说明

v1版本API使用sms.cn-north-1.myhuaweicloud.com，v3版本API使用sms.ap- southeast-1.myhuaweicloud.com。

1.4 基本概念

● 账号

用户注册时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用他们进行日常管理工作。

● 用户

由账号在IAM中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。

在我的凭证下，您可以查看账号ID和IAM用户ID。通常在调用API的鉴权过程中，

您需要用到账号、用户和密码等信息。

● 区域（Region）

从地理位置和网络时延维度划分，同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属 Region，通用Region指面向公共租户提供通用云服务的Region；专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。

详情请参见区域和可用区。

● 可用区（AZ，Availability Zone）

一个可用区是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。

● 项目

区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中创建资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。

图1-1 项目隔离模型

同样在我的凭证下，您可以查看项目ID。

(7)

● 企业项目

企业项目是项目的升级版，针对企业不同项目间资源的分组和管理，是逻辑隔离。企业项目中可以包含多个区域的资源，且项目中的资源可以迁入迁出。

关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。

(8)

2 ^{API 概览}

主机迁移服务所提供的接口为SMS接口。通过使用SMS接口，您可以完整的使用主机迁移服务的所有功能，包括查询源端服务器列表、创建迁移任务和查看迁移进度等。

表2-1 主机迁移服务接口列表

类型说明

源端管理可以实现上报源端服务器基本信息、查询源端服务器列表

以及删除源端服务器的操作。

任务管理租户用于管理迁移任务的相关接口，包括迁移任务的创

建、启动、停止、查询和删除等操作。

证书管理可以实现下载SSLsocket证书和私钥、下载RSA公私钥的操作。

命令管理可以实现获取服务端命令以及上报服务端命令执行结果的

操作。

模板管理可以实现查询模板列表、查询制定ID模板信息以及新增、

修改、删除模板信息等操作。

(9)

3 ^{如何调用 API}

3.1 构造请求

本节介绍REST API请求的组成，并以调用IAM服务的获取用户Token说明如何调用 API，该API获取用户的Token，Token可以用于调用其他API时鉴权。

您还可以通过这个视频教程了解如何构造请求调用API：https://

bbs.huaweicloud.com/videos/102987。

请求 URI

请求URI由如下部分组成：

{URI-scheme}://{Endpoint}/{resource-path}?{query-string}

尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。

表3-1 URI 中的参数说明

参数描述

URI-scheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议。

Endpoint 指定承载REST服务端点的服务器域名或IP，不同服务不同区域的 Endpoint不同，您可以从地区和终端节点获取。

例如IAM服务在“华北-北京一”区域的Endpoint为“iam.cn- north-1.myhuaweicloud.com”。

resource-path 资源路径，也即API访问路径。从具体API的URI模块获取，例如

“获取用户Token”API的resource-path为“/v3/auth/tokens”。

query-string 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如

“limit=10”，表示查询不超过10条数据。

(10)

例如您需要获取IAM在“华北-北京一”区域的Token，则需使用“华北-北京一”区域的Endpoint（iam.cn-north-1.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。

https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

图3-1 URI 示意图

说明

为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。

这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求方法

HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。

表3-2 HTTP 方法

方法说明

GET 请求服务器返回指定资源。

PUT 请求服务器更新指定资源。

POST 请求服务器新增资源或执行特殊操作。

DELETE 请求服务器删除指定资源，如删除对象等。

HEAD 请求服务器资源头部。

PATCH 请求服务器更新资源的部分内容。

当资源不存在的时候，PATCH可能会去创建一个新的资源。

在获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为：

POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

请求消息头

附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。

详细的公共请求消息头字段请参见表3-3。

(11)

表3-3 公共请求消息头

名称描述是否必选示例

Host 请求的服务器信

息，从服务API的 URL中获取。值为 hostname[:port]。

端口缺省时使用默认的端口，https的默认端口为443。

否

使用AK/SK认证时该字段必选。

code.test.com or

code.test.com:443

Content-Type 消息体的类型（格式）。推荐用户使用默认值application/json，

有其他取值时会在具体接口中专门说明。

是 application/json

Content-

Length 请求body长度，单

位为Byte。否 3495

X-Project-Id project id，项目编号。请参考获取项目ID章节获取项目编号。

否

如果是专属云场景采用AK/SK认证方式的接口请求或者多project 场景采用AK/SK认证的接口请求，则该字段必选。

e9993fc787d94b6c886cb aa340f9c0f4

X-Auth-Token 用户Token。

用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。

请求响应成功后在响应消息头

（Headers）中包含的“X-Subject- Token”的值即为 Token值。

否

使用Token认证时该字段必选。

注：以下仅为Token示例片段

MIIPAgYJKoZIhvcNAQcCo ...ggg1BBIINPXsidG9rZ

说明

API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。

AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。

(12)

对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。

POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

请求消息体（可选）

该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中 Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。

每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。

对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中

username

为用户名，

domainname

为用户所属的账号名称，

********

为用户登录密码，

xxxxxxxxxxxxxxxxxx

为project的名称，如“cn-north-1”，您可以从地区和终端节点获取。

说明

scope参数定义了Token的作用域，下面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见获取用户Token。

POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

{ "auth": { "identity": { "methods": [ "password"

],

"password": { "user": {

"name": "username", "password": "********", "domain": {

"name": "domainname"

} } } }, "scope": { "project": {

"name": "xxxxxxxxxxxxxxxxxx"

} } } }

到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中“x- subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

(13)

3.2 认证鉴权

调用接口有如下两种认证方式，您可以选择其中一种进行认证鉴权。

● Token认证：通过Token认证通用请求。

● AK/SK认证：通过AK（Access Key ID）/SK（Secret Access Key）加密调用请求。

推荐使用AK/SK认证，其安全性比Token认证要高。

Token 认证

说明

Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。

Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。

Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。

Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的 Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择 project，如下所示。

{ "auth": { "identity": { "methods": [ "password"

],

"name": "username", "password": "********", "domain": {

"name": "domainname"

} } } }, "scope":{

"project":{

"name":"xxxxxxxx"

} } } }

获取Token后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，

其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token:

ABCDEFJ....”加到请求消息头即可，如下所示。

POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projects Content-Type: application/json

X-Auth-Token: ABCDEFJ....

您还可以通过这个视频教程了解如何使用Token认证：https://

bbs.huaweicloud.com/videos/101333。

(14)

AK/SK 认证

说明

AK/SK签名认证方式仅支持消息体大小12MB以内，12MB以上的请求请使用Token认证。

AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。

● AK（Access Key ID）：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。

● SK（Secret Access Key）：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。

使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。

说明

签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

3.3 返回结果

状态码

请求发送以后，您会收到响应，包含状态码、响应消息头和消息体。

状态码是一组从1xx到5xx的数字代码，状态码表示了请求响应的状态，完整的状态码列表请参见状态码。

对于获取用户Token接口，如果调用后返回状态码为“201”，则表示请求成功。

响应消息头

对应请求消息头，响应同样也有消息头，如“Content-type”。

对于获取用户Token接口，返回如图3-2所示的消息头，其中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

(15)

图3-2 获取用户 Token 响应消息头

响应消息体（可选）

该部分可选。响应消息体通常以结构化格式（如JSON或XML）返回，与响应消息头中 Content-Type对应，传递除响应消息头之外的内容。

对于获取用户Token接口，返回如下消息体。为篇幅起见，这里只展示部分内容。

{ "token": {

"expires_at": "2019-02-13T06:52:13.855000Z", "methods": [

"password"

],

"catalog": [ {

"endpoints": [ {

"region_id": "az-01", ...

当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。

{ "error_msg": "The format of message is error", "error_code": "AS.0001"

}

其中，error_code表示错误码，error_msg表示错误描述信息。

(16)

4 ^应用示例

4.1 示例一：创建迁移任务

场景描述

本章节指导用户通过API创建迁移任务。API的调用方法请参见如何调用API。

涉及接口

● 获取IAM用户Token（使用密码）：用于鉴权认证。

● 上报源端服务器基本信息：上报源端服务器信息注册源端。

● 创建迁移任务：通过源端和目的端的AK和SK创建迁移任务。

● 查询指定ID的迁移任务：根据迁移任务ID查询任务详情，确定迁移任务是否创建

成功。

前提条件

● 已获取目的端AK/SK，参见创建访问秘钥(AK/SK)。

操作步骤

步骤1 获取IAM用户Token。

● 接口相关信息

URI格式：POST /v3/auth/tokens

详情请参见获取IAM用户Token（使用密码）。

● 请求示例

POST: https://{iam_endpoint}/v3/auth/tokens

{endpoint}信息请从地区和终端节点获取。

Body：

{ "auth": { "identity": { "methods": [ "password"

],

(17)

"name": "username", "domain": {

"name": "domainname"

},

"password": "******"

} } }, "scope": { "project": {

"id": "0215ef11e49d4743be23dd97a1561e91"

} } } }

响应Header中“X-Subject-Token”的值即为Token：

X-Subject-Token:MIIDkgYJKoZIhvcNAQcCoIIDgzCCA38CAQExDTALBglghkgBZQMEAgEwgXXXXX...

步骤2 上报源端服务器信息注册源端。

● 接口相关信息 URI格式：

POST /v3/sources

详情请参见上报源端服务器基本信息。

● 请求示例

POST https://sms.ap-southeast-1.myhuaweicloud.com/v3/sources

Header：

Content-Type: application/json X-Auth-Token: "Token"

Body：

{ "os_type": "LINUX", "name": "bike-centos",

"os_version": "CENTOS_7_4_64BIT",

"linux_block_check": "{\"release_type\": \"CENTOS\", \"release_version\": \"7.4.1708\",

\"kernel_simplification\": \"3.10.0\", \"architecture\": \"x86_64\", \"kernel_version\":

\"3.10.0-1062.1.1.el7.x86_64\"}",

"kernel_version": "3.10.0-1062.1.1.el7.x86_64", "virtualization_type": "HVM",

"paravirtualization": true, "firmware": "BIOS", "has_rsync": true, "boot_loader": "GRUB", "disks": [{

"name": "/dev/vda", "size": 42949672960, "device_use": "BOOT", "partition_style": "MBR", "physical_volumes": [{

"name": "/dev/vda1", "size": 42948624384, "device_use": "OS", "used_size": 2854862848, "inode_size": "256", "file_system": "ext4", "mount_point": "/"

}]

}],

"volume_groups": [], "cpu_quantity": 1, "memory": 1038716928,

(18)

"networks": [{

"name": "eth0", "ip": "192.168.77.77",

"mac": "ef05f3911eeccb12a0a8931dc198af84e848b0e9e3edd0812805429fc64910c1"

}],

"ip": "192.168.77.77", "agent_version": "1.2.3-beta"

}

● 响应示例

{ "id": "33b798a8-4f80-49ce-8b8a-18a85adfe13e"

}

步骤3 调用创建任务接口创建迁移任务。

POST /v3/tasks

详情请参见创建迁移任务。

● 请求示例

POST https://sms.ap-southeast-1.myhuaweicloud.com/v3/tasks

Header：

Content-Type: application/json X-Auth-Token: "Token"

Body：

{ "auto_install_pvdriver" : true, "auto_start" : true,

"syncing": false,

"migration_ip" : "172.16.0.216", "name" : "MigrationTask", "os_type" : "WINDOWS",

"project_id" : "05825205120026802xxxx01721bc1f35", "project_name" : "cn-north-4",

"region_id" : "cn-north-4", "region_name" : "华北-北京四", "source_server" : {

"id" : "9a01cb97-3eec-440e-xxxx-04016a8d7502"

},

"start_target_server" : true, "target_server" : {

"name" : "chengxiao-startTT",

"vm_id" : "6dac09d8-5835-4888-xxxx-787453c4e1d4", "disks" : [{

"device_use" : "OS",

"disk_id" : "354419d9-bd41-4b50-xxxx-e4f6f57c66fc", "name" : "Disk 0",

"physical_volumes" : [{

"device_use" : "BOOT", "file_system" : "NTFS", "index" : 1,

"name" : "(Reserved)", "size" : 367001600, "used_size" : 31244288,

"uuid" : "\\\\?\\Volume{b99b1c6f-75ef-xxxx-80b3-806e6f6e6963}\\"

}, {

"device_use" : "OS", "file_system" : "NTFS", "index" : 2,

"name" : "C:\\", "size" : 42580574208, "used_size" : 16148279296,

"uuid" : "\\\\?\\Volume{b99b1c70-75ef-xxxx-80b3-806e6f6e6963}\\"

}

(19)

],

"size" : 42949672960, "used_size" : 42949672960 }, {

"device_use" : "NORMAL",

"disk_id" : "ef409e5f-2321-49d1-xxxx-027fc93985ef", "name" : "Disk 1",

"physical_volumes" : [{

"file_system" : "NTFS", "index" : 1,

"name" : "D:\\", "size" : 53684994048, "used_size" : 3462647808,

"uuid" : "\\\\?\\Volume{9f817be3-2cea-xxxx-816f-e995816380e2}\\"

} ],

"size" : 53687091200, "used_size" : 53687091200 }

],

"btrfs_list" : null },

"type" : "MIGRATE_BLOCK", "use_public_ip" : false }

● 响应示例

{ "id": "8abda8635e09d185015e09d188dd0001xx"

}

步骤4 调用查看任务接口，查看任务状态。

GET /v3/tasks/{task_id}

详情请参见查询指定ID的迁移任务。

● 请求示例

GET https://sms.ap-southeast-1.myhuaweicloud.com/v3/tasks/

8abda8635e09d185015e09d188dd0001xx

Header：

Content-Type: application/json X-Auth-Token: “Token”

● 响应示例

{ "id": "8abda8635e09d185015e09d188dd0001xx", "name": "MigrationTask",

"type": "MIGRATE_FILE", "os_type": "LINUX", "state": "READY",

"estimate_complete_time": 1600391014000, "create_date": 1600159831000,

"start_date": 1600159831000, "finish_date": 1600343128000, "priority": 1,

"speed_limit": 0, "migrate_speed": 0, "start_target_server": true, "error_json": "",

"total_time": 935000, "float_ip": "192.168.0.194", "migration_ip": "192.168.0.194", "vm_template_id": null,

"region_name": "CN-Hong Kong", "region_id": "ap-southeast-1", "project_name": "ap-southeast-1",

(20)

"project_id": "05825205120026802ff0c01721bc1f35", "sub_tasks": [

{ "id": 3514,

"name": "SSL_CONFIG", "progress": 100,

"start_date": 1600159847000, "end_date": 1600159851000, "user_op": "REPLICATE"

}, {

"id": 3515,

"name": "ATTACH_AGENT_IMAGE", "progress": 100,

}, {

"id": 3516,

"name": "FORMAT_DISK_LINUX_FILE", "progress": 100,

}, {

"id": 3517,

"name": "MIGRATE_LINUX_FILE", "progress": 100,

}, {

"id": 3582,

"name": "CONFIGURE_LINUX_FILE", "progress": 100,

"start_date": 1600333914000, "end_date": 1600334025000, "user_op": "CUTOVER0"

}, {

"id": 3583,

"name": "DETTACH_AGENT_IMAGE", "progress": 100,

}, {

"id": 3584,

"start_date": 1600334185000, "end_date": 1600334188000, "user_op": "RESYNC0"

}, {

"id": 3585,

}, {

"id": 3586,

"name": "SYNC_LINUX_FILE",

(21)

"progress": 100,

}, {

"id": 3587,

}, {

"id": 3588,

}, {

"id": 3589,

}, {

"id": 3590,

}, {

"id": 3591,

"name": "SYNC_LINUX_FILE", "progress": 100,

} ],

"source_server": {

"id": "621f2cb5-ba4f-4819-b00d-ee48ca2c35ea", "ip": "192.168.0.176",

"name": "ecs-4bb4", "os_type": "LINUX",

"os_version": "CENTOS_7_6_64BIT", "oem_system": false,

"state": "syncing",

"migration_cycle": "syncing"

}, "target_server": {

"id": "de35f45d-b6d5-4769-9148-984c8fab44f2", "vm_id": "6d51477f-0a02-4917-8d7d-b13969f4abd8", "name": "ecs-4bb4",

"ip": null,

"os_type": "LINUX", "os_version": null, "system_dir": null, "disks": [ { "id": 86364, "name": "/dev/sda", "relation_name": "/dev/vda",

(22)

"disk_id": "ed3c78d0-3166-48d1-bee0-d29e7d834916", "partition_style": "MBR",

"size": 42949672960, "used_size": 42948624384, "device_use": "BOOT", "os_disk": false, "physical_volumes": [ {

"id": 132594, "uuid": null, "index": 0,

"name": "/dev/sda1", "relation_name": "/dev/vda1", "device_use": "OS",

"file_system": "ext4", "mount_point": "/", "size": 42948624384, "used_size": 2467393536, "free_size": 40481230848 }

],

"disk_index": "z"

} ],

"volume_groups": [],

"image_disk_id": "9700f5ce-02ae-4a71-a057-deffe9b69269", "rollback_snapshot_ids": null

}, "clone_server": null, "target_snapshot_id": null, "remain_seconds": 60000 }

state表示任务执行状态，READY代表任务准备就绪。

----结束

4.2 示例二：启动迁移任务

场景描述

本章节指导用户通过API启动迁移任务。API的调用方法请参见如何调用API。

启动迁移任务前需要获取Token，启动迁移任务后，需要查询任务状态详情，失败或暂停中的任务才能被启动。

涉及接口

● 管理迁移任务(启动)：通过源端和目的端的AK和SK启动失败或者暂停的迁移任

务。

● 查询指定ID的迁移任务：根据迁移任务ID查询任务详情，确定迁移任务是否启动

成功。

操作步骤

(23)

● 请求示例

Body：

],

"name": "testname", "domain": {

"name": "testname"

},

"password": "Password"

"id": "0215ef11e49d4743be23dd97a1561e91"

} } } }

步骤2 调用启动任务接口启动迁移任务。

POST /v3/tasks/{task_id}/action

详情请参见管理迁移任务(启动)。

● 请求示例

POST https://sms.ap-southeast-1.myhuaweicloud.com/v3/tasks/

8abda8635e09d185015e09d188dd0001xx/action

Header：

Body:

{ "operation" : "start", }

响应200表示调用成功。

● 请求示例

8abda8635e09d185015e09d188dd0001xx

(24)

Header：

● 响应示例

"type": "MIGRATE_FILE", "os_type": "LINUX", "state": "RUNNING",

{ "id": 3514,

}, {

"id": 3515,

}, {

"id": 3516,

}, {

"id": 3517,

}, {

"id": 3582,

},

(25)

{ "id": 3583,

}, {

"id": 3584,

}, {

"id": 3585,

}, {

"id": 3586,

}, {

"id": 3587,

}, {

"id": 3588,

}, {

"id": 3589,

}, {

"id": 3590,

}, {

"id": 3591,

"start_date": 1600390954000,

(26)

"end_date": 1600390954000, "user_op": "RESYNC1"

} ],

"source_server": {

"state": "syncing",

"ip": null,

"size": 42949672960, "used_size": 42948624384, "device_use": "BOOT", "os_disk": false, "physical_volumes": [ {

],

"disk_index": "z"

} ],

state表示任务执行状态，RUNNING代表正在执行，MIGRATE_SUCCESS表示执行成功。

----结束

(27)

4.3 示例三：暂停并删除迁移任务

场景描述

本章节指导用户通过API暂停并删除迁移任务。API的调用方法请参见如何调用API。

删除迁移任务前，需要获取Token并暂停迁移任务，暂停迁移任务后，需查询任务状态详情，当迁移任务暂停后，才能删除迁移任务。

涉及接口

● 管理迁移任务（暂停）：根据迁移任务ID暂停迁移任务。

● 查询指定ID的迁移任务：根据迁移任务ID查询任务详情，确定迁移任务是否暂停

成功。

● 删除指定ID的迁移任务：根据迁移任务ID删除迁移任务。

操作步骤

● 请求示例

Body：

],

"name": "testname", "domain": {

"name": "testname"

},

"password": "Password"

"id": "0215ef11e49d4743be23dd97a1561e91"

} } } }

(28)

步骤2 调用暂停任务接口暂停迁移任务。

POST /v3/tasks/{task_id}/action

详情请参见管理迁移任务（暂停）。

● 请求示例

POST https://sms.ap-southeast-1.myhuaweicloud.com/v3/tasks/

8abda8635e09d185015e09d188dd0001xx/action

Header：

Body:

{ "operation" : "stop"

}

响应200表示调用成功。

● 请求示例

8abda8635e09d185015e09d188dd0001xx

Header：

● 响应示例

"type": "MIGRATE_FILE", "os_type": "LINUX", "state": "ABORT",

{ "id": 3514,

"start_date": 1600159847000,

(29)

"end_date": 1600159851000, "user_op": "REPLICATE"

}, {

"id": 3515,

}, {

"id": 3516,

}, {

"id": 3517,

}, {

"id": 3582,

}, {

"id": 3583,

}, {

"id": 3584,

}, {

"id": 3585,

}, {

"id": 3586,

}, {

"id": 3587,

(30)

}, {

"id": 3588,

}, {

"id": 3589,

}, {

"id": 3590,

}, {

"id": 3591,

} ],

"source_server": {

"state": "syncing",

"ip": null,

"size": 42949672960, "used_size": 42948624384, "device_use": "BOOT", "os_disk": false, "physical_volumes": [

(31)

{

],

"disk_index": "z"

} ],

state表示任务执行状态，ABORT代表任务终止。

步骤4 调用删除任务接口删除迁移任务。

DELETE /v3/tasks/{task_id}

详情请参见删除指定ID的迁移任务。

● 请求示例

https://sms.ap-southeast-1.myhuaweicloud.com/v3/tasks/8abda8635e09d185015e09d188dd0001xx

Header：

响应200表示删除成功。

----结束

(32)

5 ^{API v3}

5.1 源端管理

5.1.1 查询待迁移源端的所有错误

功能介绍

主机迁移过程中可能发生错误，使用该接口可以批量查询迁移过程中出现错误的源端服务器信息，以及它们的错误信息。

调试

您可以在API Explorer中调试该接口。

URI

GET /v3/errors

表5-1 Query 参数

参数是否必选参数类型描述

limit 否 Integer 每一页记录的错误数量

最小值：0 最大值：100 缺省值：50

offset 是 Integer 偏移量

最小值：0 最大值：65535 缺省值：0

(33)

migproject 否 String 需要查询的迁移项目id，添加此字段将只查询对应id下的迁移任务报错信息

最小长度：0 最大长度：255 enterprise_pro

ject_id 否 String 需要查询的企业项目id

最小长度：0 最大长度：255

请求参数

表5-2 请求 Header 参数

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

响应参数

状态码： 200

表5-3 响应 Body 参数

参数参数类型描述

count Integer 迁移过程中发生错误的源端数量最小值：0

最大值：2147483647 migration_err

ors Array of MigrationErr ors objects

迁移过程中发生的错误详情

(34)

表5-4 MigrationErrors

error_json String 保存错误信息的json字符串最小长度：0

最大长度：255

host_name String 主机名称（从用户系统获取，可能为空）

name String 源端在主机迁移服务中的名称最小长度：0

最大长度：255 source_id String 源端服务器id

最小长度：0 最大长度：255 source_ip String 源端服务器的ip

最小长度：0 最大长度：255 target_ip String 目的端服务器的ip

请求示例

批量查询迁移过程中出现错误的源端服务器信息，每页10个源端，查看第0页。

GET https://{endpoint}/v3/errors?limit=10&offset=0

响应示例

状态码： 200 OK

{ "count" : 4,

"migration_errors" : [ {

"source_id" : "b5d13e46-fb5f-41da-952a-d7a38c1e47fd", "source_ip" : "192.168.0.235",

"target_ip" : null, "name" : "sms-ubuntu", "host_name" : null,

"error_json" : "{\"error_code\":\"SMS.1302\",\"error_param\":\"[\\\"/\\\", \\\"/mnt/vdb1\\\"]\"}"

}, {

"source_id" : "e7029ea3-fec8-49ca-9cae-9158af0d8419", "source_ip" : "192.168.0.163",

"target_ip" : null, "name" : "sms-win08",

(35)

"host_name" : "sms-win08",

"error_json" : "{\"error_param\":\"[\\\"192.168.0.1\\\"]\",\"error_code\":\"SMS.2802\"}"

}, {

"source_id" : "c4d1d596-24c2-49ec-9fcf-32e9d28f750d", "source_ip" : "192.168.0.154",

"target_ip" : null, "name" : "sms-win16", "host_name" : "sms-win16",

"error_json" : "{\"error_code\":\"SMS.1114\",\"error_param\":\"[]\"}"

}, {

"source_id" : "490d5aac-f8de-4479-811e-72ed30834be4", "source_ip" : "192.168.77.77",

"target_ip" : null, "name" : "sms-centos", "host_name" : null,

"error_json" : "{\"error_code\":\"SMS.3805\",\"error_param\":\"[]\"}"

} ] }

状态码

状态码描述

200 OK

错误码

请参见错误码。

5.1.2 上报源端服务器基本信息

功能介绍

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

调试

您可以在API Explorer中调试该接口。

URI

POST /v3/sources

(36)

请求参数

表5-5 请求 Header 参数

X-Auth-Token 是 String 用户Token。

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

表5-6 请求 Body 参数

id 否 String 源端在SMS数据库中的ID

ip 是 String 源端服务器ip，注册源端时必

选，更新非必选最小长度：0 最大长度：255

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

hostname 否 String 源端主机名，注册源端必选，更新非必选

os_type 是 String 源端服务器的OS类型，分为

Windows和Linux，注册必选，

更新非必选最小长度：0 最大长度：255 枚举值：

● WINDOWS

● LINUX

(37)

os_version 否 String 操作系统版本，注册必选，更新非必选

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 BtrfsFileSyste m objects

Linux 必选，源端的Btrfs信息。

如果源端不存在Btrfs，则为[]

networks 否 Array of NetWork objects

源端服务器的网卡信息

domain_id 否 String 租户的domainId 最小长度：0 最大长度：255

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

paravirtualiza

tion 否 Boolean Linux场景必选，源端是否是半

虚拟化

raw_devices 否 String Linux必选，裸设备列表最小长度：0

最大长度：255

(38)

driver_files 否 Boolean Windows 必选，是否缺少驱动文件

system_servic

es 否 Boolean Windows必选，是否存在不正

常服务 account_right

s 否 Boolean Windows必选，权限是否满足

要求

boot_loader 否 String Linux必选，系统引导类型，

BOOT_LOADER(GRUB/LILO) 枚举值：

● GRUB

● LILO

system_dir 否 String Windows必选，系统目录最小长度：0

最大长度：255 volume_group

s 否 Array of

VolumeGrou ps objects

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

agent_version 是 String Agent版本最小长度：0 最大长度：255

表5-7 ServerDisk

name 是 String 磁盘名称

partition_style 否 String 磁盘的分区类型，添加源端时源端磁盘必选

枚举值：

● MBR

● GPT device_use 是 String 磁盘类型

枚举值：

● BOOT

● OS

(39)

size 是 Long 磁盘总大小，以字节为单位

最小值：0

最大值：9223372036854775807

used_size 是 Long 磁盘已使用大小，以字节为单位

最小值：0

最大值：9223372036854775807

physical_volu

mes 是 Array of

PhysicalVolu me objects

磁盘上的物理分区信息

os_disk 否 Boolean 是否为系统盘

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

表5-8 PhysicalVolume

device_use 否 String 分区类型，普通分区，启动分区，系统分区

最小长度：0 最大长度：255 file_system 否 String 文件系统类型

index 否 Integer 顺序

最小值：0

最大值：2147483647 mount_point 否 String 挂载点

name 否 String 名称，windows表示盘符，

Linux表示设备号最小长度：0 最大长度：255

(40)

size 否 Long 大小

最小值：0

最大值：9223372036854775807

used_size 否 Long 使用大小

最小值：0

最大值：9223372036854775807

uuid 否 String GUID，可从源端查询

最小长度：0 最大长度：255 size_per_clust

er 否 Integer 每个cluster大小

最小值：0

最大值：2147483647

表5-9 BtrfsFileSystem

name 是 String 文件系统名称

label 是 String 文件系统标签，若无标签为空字

符串

uuid 是 String 文件系统的uuid

最小长度：0 最大长度：255 device 是 String btrfs包含的设备名称

size 是 Long 文件系统数据占用大小

最小值：0

最大值：9223372036854775807

(41)

nodesize 是 Long btrfs节点大小

最小值：0

最大值：9223372036854775807

sectorsize 是 Integer 扇区大小最小值：0

最大值：2147483647 data_profile 是 String 数据配置（RAD）

system_profile 是 String 文件系统配置（RAD）

最小长度：0 最大长度：255 metadata_prof

ile 是 String 元数据配置（RAD）

最小长度：0 最大长度：255 global_reserve

1 是 String Btrfs文件系统信息

最小长度：0 最大长度：255 g_vol_used_si

ze 是 Long Btrfs卷已使用空间大小

最小值：0

最大值：9223372036854775807

default_subvo

lid 是 String 默认子卷ID

最小长度：0 最大长度：255 default_subvo

l_name 是 String 默认子卷名称

最小长度：0 最大长度：255 default_subvo

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

最小长度：0 最大长度：255 subvolumn 是 Array of

BtrfsSubvolu mn objects

子卷信息

(42)

表5-10 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 子卷的挂载路径

表5-11 NetWork

name 是 String 网卡的名称

ip 是 String 该网卡绑定的IP

netmask 是 String 掩码

gateway 是 String 网关

(43)

mtu 否 Integer Linux必选，网卡的MTU

最小值：0

最大值：2147483647

mac 是 String Mac地址

id 否 String 数据库Id

表5-12 VolumeGroups

components 否 String Pv信息最小长度：0 最大长度：255

free_size 否 Long 剩余空间

最小值：0

最大值：9223372036854775807

logical_volum

es 否 Array of

LogicalVolum es objects

lv信息

name 否 String 名称

size 否 Long 大小

最小值：0

最大值：9223372036854775807

(44)

表5-13 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 挂载点

name 是 String 名称

size 是 Long 大小

最小值：0

最大值：9223372036854775807

used_size 是 Long 使用大小

最小值：0

最大值：9223372036854775807

free_size 是 Long 剩余空间

最小值：0

最大值：9223372036854775807

响应参数

状态码： 200

(45)

表5-14 响应 Body 参数

id String 源端id

请求示例

安装在源端服务器上的迁移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,

API v3_主机迁移服务 SMS_API参考_华为云

API 参考

目 录

1 使用前必读... 1

2 API 概览... 4

3 如何调用 API...5

4 应用示例...12

5 API v3... 28

6 附录... 228

A 修订记录... 268

1 使用前必读

1.1 概述

1.2 调用说明

1.3 终端节点

1.4 基本概念

2 API 概览

3 如何调用 API

3.1 构造请求

请求 URI

请求方法

请求消息头

请求消息体（可选）

username

domainname

********

xxxxxxxxxxxxxxxxxx

3.2 认证鉴权

Token 认证

AK/SK 认证

3.3 返回结果

状态码

响应消息头

响应消息体（可选）

4 应用示例

4.1 示例一：创建迁移任务

场景描述

涉及接口

前提条件

操作步骤

4.2 示例二：启动迁移任务

场景描述

涉及接口

操作步骤

4.3 示例三：暂停并删除迁移任务

场景描述

涉及接口

操作步骤

5 API v3

5.1 源端管理

5.1.1 查询待迁移源端的所有错误

功能介绍

调试

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

5.1.2 上报源端服务器基本信息

功能介绍

调试

URI

请求参数

响应参数

请求示例

目录

1 ^{使用前必读}

2 ^{API 概览}

3 ^{如何调用 API}

4 ^应用示例

5 ^{API v3}