API standards and multilingual preset SDKs
The OpenAPI of this product (smc/2019-06-01) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Migration source
|
API |
Title |
Description |
| DescribeSourceServers | DescribeSourceServers | Call the DescribeSourceServers operation to query information about one or more migration sources. |
| ModifySourceServerAttribute | ModifySourceServerAttribute | The ModifySourceServerAttribute operation modifies the name and description of a migration source. |
| DeleteSourceServer | DeleteSourceServer | You can call the DeleteSourceServer operation to delete a migration source. |
Migration task
|
API |
Title |
Description |
| CreateReplicationJob | CreateReplicationJob | Creates a migration task for a source server. |
| CreateCrossZoneMigrationJob | CreateCrossZoneMigrationJob | Server Migration Center (SMC) lets you migrate an Alibaba Cloud Elastic Compute Service (ECS) instance to a different zone within the same region and change its instance type, including the vCPU and memory, within the same instance family. This feature helps you meet business requirements for instance migration and specification changes. Call this operation to create a cross-zone migration job. |
| ModifyReplicationJobAttribute | ModifyReplicationJobAttribute | You can call the ModifyReplicationJobAttribute operation to modify the information of a migration task. |
| StartReplicationJob | StartReplicationJob | You can call the StartReplicationJob operation to start a migration task. |
| StopReplicationJob | StopReplicationJob | You can call the StopReplicationJob operation to stop a migration task. |
| DescribeReplicationJobs | DescribeReplicationJobs | Retrieves details about one or more migration tasks. |
| CutOverReplicationJob | CutOverReplicationJob | Stops the periodic execution of a specified incremental migration job and completes the migration. |
| DeleteReplicationJob | DeleteReplicationJob | You can call DeleteReplicationJob to delete a migration job. |
Workgroup
|
API |
Title |
Description |
| CreateWorkgroup | CreateWorkgroup | Workgroups are used to manage the lifecycle of multiple migration tasks in batch server migration scenarios. |
| AssociateSourceServers | AssociateSourceServers | To migrate servers as a group, you must first associate the migration sources with that group. |
| DisassociateSourceServers | DisassociateSourceServers | Disassociate a migration source from a group if you no longer need to use the group for batch migration or want to delete the group. |
| DescribeWorkgroups | DescribeWorkgroups | After a workgroup is created, you can view its information, such as the workgroup name, description, and alert information. |
| ModifyWorkgroupAttribute | ModifyWorkgroupAttribute | Modifies a workgroup's name and description. |
| DeleteWorkgroup | DeleteWorkgroup | You can delete a workgroup that you no longer need. |
Tag
|
API |
Title |
Description |
| CreateAccessToken | CreateAccessToken | Creates an activation code. |
| DisableAccessToken | DisableAccessToken | You can call the DisableAccessToken operation to disable an activation code. |
| ListAccessTokens | ListAccessTokens | Call the ListAccessTokens operation to query for created activation codes and their statuses. |
| DeleteAccessToken | DeleteAccessToken | Deletes an activation code. |
Activation code
|
API |
Title |
Description |
| ListTagResources | ListTagResources | Queries the tags attached to one or more SMC resources, such as migration sources and migration tasks. |
| TagResources | TagResources | You can call TagResources to create and attach tags to multiple SMC resources, such as migration sources and migration tasks. |
| UntagResources | UntagResources | Detaches and deletes tags from specified SMC resources, such as migration sources and migration tasks. |