CLI命令参考
查询API版本信息
源端管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询待迁移源端的所有错误 | hcloud SMS ListErrorServers | 主机迁移过程中可能发生错误，使用该接口可以批量查询迁移过程中出现错误的源端服务器信息，以及它们的错误信息。 | |
| 查询源端服务器列表 | hcloud SMS ListServers | 用户在源端安装并成功启动Agent后，Agent会将源端服务器信息注册在主机迁移服务中，调用该接口查询已注册的源端服务器列表信息。 | |
| 上报源端服务器基本信息 | hcloud SMS RegisterServer | 上报源端服务器信息，上报成功后会在sms服务器列表中看到对应的源端服务器信息。 | |
| 批量删除源端服务器信息 | hcloud SMS DeleteServers | 批量删除源端服务器信息。一旦源端服务器信息被删除，则只能通过重启源端服务器上的迁移Agent来将源端服务器信息重新添加在主机迁移服务界面。 | |
| 查询指定ID的源端服务器 | hcloud SMS ShowServer | 迁移Agent将源端服务器信息上报到主机迁移服务后，主机迁移服务会对迁移的可行性进行检测，该接口返回源端服务器的基本信息和检查结果。 | |
| 修改指定ID的源端服务器信息 | hcloud SMS UpdateServerName | 该功能用来修改SMS服务端的源端信息，方便用户对源端进行管理。 | |
| 删除指定ID的源端服务器信息 | hcloud SMS DeleteServer | 从主机迁移服务界面上删除指定ID的源端服务器信息。一旦源端服务器信息被删除，则只能通过重启源端服务器上的迁移Agent来将源端服务器信息重新添加在主机迁移服务界面。 | |
| 更新磁盘信息 | hcloud SMS UpdateDiskInfo | 更新服务器的磁盘信息，此接口会把服务器原有磁盘信息清空，然后更新成新磁盘信息。 | |
| 获取服务器总览 | hcloud SMS ShowOverview | 获取服务器总览 | |
| 更新任务对应源端复制状态 | hcloud SMS UpdateCopyState | 更新任务对应源端复制状态。 |
Agent运行
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 获取Agent配置信息 | hcloud SMS ShowConfig | 源端Agent启动后，访问此接口获取配置信息。 |
任务管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询迁移任务列表 | hcloud SMS ListTasks | 在设置目的端后，主机迁移服务会自动创建迁移任务，使用该接口可以查询迁移任务列表。 | |
| 创建迁移任务 | hcloud SMS CreateTask | 根据源端服务器创建一个迁移任务。 | |
| 批量删除迁移任务 | hcloud SMS DeleteTasks | 批量删除迁移任务。 | |
| 查询指定ID的迁移任务 | hcloud SMS ShowTask | 查询指定ID的迁移任务。 | |
| 删除指定ID的迁移任务 | hcloud SMS DeleteTask | 删除指定ID的迁移任务。 | |
| 更新指定ID的迁移任务 | hcloud SMS UpdateTask | 更新指定ID的迁移任务 | |
| 管理迁移任务 | hcloud SMS UpdateTaskStatus | 管理迁移任务，包括启动任务，暂停任务，同步任务，日志上传，删除快照资源等。 | |
| 上报数据迁移进度和速率 | hcloud SMS UpdateTaskSpeed | 此接口由安装在源端服务器上的迁移Agent在数据迁移阶段调用，用来将迁移的具体进度上报给SMS服务端。 | |
| 查询任务限速规则 | hcloud SMS ShowsSpeedLimits | 按时间段查询迁移任务的迁移速率。 | |
| 设置迁移限速规则 | hcloud SMS UpdateSpeed | 设置迁移任务的迁移速率。 | |
| 查询指定任务ID的安全传输通道的证书passphrase | hcloud SMS ShowPassphrase | 查询指定任务ID的安全传输通道的证书passphrase。 | |
| 上传迁移任务的日志 | hcloud SMS CollectLog | 上传迁移任务的日志。 | |
| 获取一致性校验结果 | hcloud SMS ShowConsistencyResult | 获取一致性校验结果简报 | |
| 上传一致性校验结果 | hcloud SMS UpdateConsistencyResult | Agent 上传一致性校验结果简报 | |
| 批量获取一致性校验结果 | hcloud SMS ExportConsistencyResults | 使用该接口批量导出一致性校验结果 |
命令管理
模板管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询模板列表 | hcloud SMS ListTemplates | 查询弹性云服务器模板列表，迁移时选择“新建服务器”时可使用该模板创建弹性云服务器。 | |
| 新增模板信息 | hcloud SMS CreateTemplate | 新增源端模板信息。 | |
| 批量删除指定ID的模板 | hcloud SMS DeleteTemplates | 批量删除指定ID的模板。 | |
| 查询指定ID模板信息 | hcloud SMS ShowTemplate | 查询指定ID的弹性云服务器模板信息。 | |
| 修改模板信息 | hcloud SMS UpdateTemplate | 修改源端模板信息。 | |
| 删除指定ID的模板 | hcloud SMS DeleteTemplate | 删除指定ID的模板。 | |
| 查询指定ID的模板中的目的端服务器的密码 | hcloud SMS ShowTargetPassword | 查询指定ID的模板中的目的端服务器的密码。 |
迁移项目管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 获取项目列表 | hcloud SMS ListMigprojects | 主机迁移服务中可以使用迁移项目来对源端进行项目管理，使用该接口获取当前账户下所有的迁移项目列表。 | |
| 新建迁移项目 | hcloud SMS CreateMigproject | 新建迁移项目。 | |
| 查询指定ID迁移项目详情 | hcloud SMS ShowMigproject | 查询指定ID的迁移项目详情。 | |
| 更新迁移项目信息 | hcloud SMS UpdateMigproject | 更新迁移项目的信息。 | |
| 删除迁移项目 | hcloud SMS DeleteMigproject | 删除指定ID的迁移项目。 | |
| 更新默认迁移项目 | hcloud SMS UpdateDefaultMigproject | 更改默认迁移项目，注册源端会注册在当前的默认项目下。 |
密钥管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 获取SSL证书和私钥 | hcloud SMS ShowCertKey | 当迁移采用块级迁移的方式时，安装在源端服务器上的迁移Agent通过SSLSocket同目的端服务器通信，该接口用于下载迁移传输过程所需要的证书和私钥(PEM格式)。 |
网络检测管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 更新网络检测相关的信息 | hcloud SMS UpdateNetworkCheckInfo | Agent 上报网络检测相关的信息。 |
