API标准及多语言预置SDK
本产品（smc/2019-06-01）的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
自定义签名场景
若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。
迁移源
|
API |
标题 |
API概述 |
| DescribeSourceServers | 查询一个或多个迁移源信息 | 调用DescribeSourceServers查询一个或多个迁移源信息。 |
| ModifySourceServerAttribute | 修改一个迁移源的名称和描述 | 调用ModifySourceServerAttribute修改一个迁移源的名称和描述。 |
| DeleteSourceServer | 删除一个迁移源 | 调用DeleteSourceServer删除一个迁移源。 |
迁移任务
|
API |
标题 |
API概述 |
| CreateReplicationJob | 创建一个迁移任务 | 调用CreateReplicationJob为迁移源创建一个迁移任务。 |
| CreateCrossZoneMigrationJob | 创建跨可用区迁移任务 | SMC支持将阿里云云服务器ECS迁移到同地域的不同可用区，同时也支持在同规格族内更改实例规格（vCPU和内存），满足您迁移云服务器ECS和变配实例规格的业务需求。您可以通过此接口创建跨可用区任务。 |
| ModifyReplicationJobAttribute | 修改迁移任务 | 调用ModifyReplicationJobAttribute修改迁移任务信息。 |
| StartReplicationJob | 启动一个迁移任务 | 调用StartReplicationJob启动一个迁移任务。 |
| StopReplicationJob | 停止一个迁移任务 | 调用StopReplicationJob停止一个迁移任务。 |
| DescribeReplicationJobs | 查询一个或多个迁移任务的详细信息 | 调用DescribeReplicationJobs查询一个或多个迁移任务的详细信息。 |
| CutOverReplicationJob | 停止周期执行自动增量任务 | 将指定的自动增量迁移任务停止周期执行，并完成迁移任务。 |
| DeleteReplicationJob | 删除一个迁移任务 | 调用DeleteReplicationJob删除一个迁移任务。 |
工作组
|
API |
标题 |
API概述 |
| CreateWorkgroup | 创建工作组 | 工作组可以同时管理多个迁移任务的生命周期，适用于需要批量迁移服务器的场景。 |
| AssociateSourceServers | 迁移源关联工作组 | 如果您需要通过工作组批量迁移服务器，需要先将迁移源关联到工作组。 |
| DisassociateSourceServers | 迁移源取消关联工作组 | 如果某个迁移源后期无需通过工作组批量迁移或者需要删除工作组，则可以取消关联工作组。 |
| DescribeWorkgroups | 查看工作组 | 创建工作组后，您可以查看工作组的相关信息，包括工作组名称、工作组描述、告警信息等。 |
| ModifyWorkgroupAttribute | 修改工作组 | 创建工作组后，您可以修改工作组的名称和描述信息。 |
| DeleteWorkgroup | 删除工作组 | 如果您后期不再需要工作组，可以删除工作组。 |
标签
|
API |
标题 |
API概述 |
| TagResources | 绑定标签 | 调用TagResources为指定的SMC资源（迁移源和迁移任务）列表统一创建并绑定标签。 |
| ListTagResources | 查询标签列表 | 调用ListTagResources查询一个或多个SMC资源（迁移源和迁移任务）已经绑定的标签列表。 |
| UntagResources | 解绑并删除标签 | 为指定的SMC资源（迁移源和迁移任务）统一解绑并删除标签。 |
激活码
|
API |
标题 |
API概述 |
| CreateAccessToken | 创建激活码 | 调用CreateAccessToken创建激活码。 |
| DisableAccessToken | 禁用激活码 | 调用DisableAccessToken禁用激活码。 |
| ListAccessTokens | 查询激活码 | 调用ListAccessTokens查询已创建的激活码以及激活码的使用情况。 |
| DeleteAccessToken | 删除激活码 | 调用DeleteAccessToken删除激活码。 |