Help Center/ Server Migration Service/ API Reference (Ally Region)/ Before You Start
Updated on 2026-01-06 GMT+08:00
View PDF
Share

Before You Start

Welcome to Server Migration Service API Reference. Server Migration Service (SMS) helps you migrate applications and data from on-premises x86 physical servers or VMs on other private clouds or cloud service platforms to Elastic Cloud Servers (ECSs) on the target cloud service platform.

This document describes how to use SMS application programming interfaces (APIs) to perform operations such as creating, deleting, and querying migration tasks. For details about all supported operations, see API Overview.

If you plan to access SMS through an API, ensure that you are familiar with SMS concepts. For details, see "Service Overview" in Server Migration Service User Guide.

Endpoints

An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see Regions and Endpoints.

Concepts

  • Account

    An account is created upon successful registration. The account has full access permissions for all of its cloud services and resources. It can be used to reset user passwords and grant user permissions. The account is a payment entity, which should not be used directly to perform routine management. For security purposes, create Identity and Access Management (IAM) users and grant them permissions for routine management.

  • User

    An IAM user is created by an account in IAM to use cloud services. Each IAM user has its own identity credentials (password and access keys).

    The account name, username, and password are required for API authentication.

  • Region

    A region is a geographic area in which cloud resources are deployed. Availability zones (AZs) in the same region can communicate with each other over an intranet, while AZs in different regions are isolated from each other. Deploying cloud resources in different regions can better suit certain user requirements or comply with local laws or regulations.

  • AZ

    An AZ contains one or more physical data centers. Each AZ has independent cooling, fire extinguishing, moisture-proof, and electricity facilities. Within an AZ, compute, network, storage, and other resources are logically divided into multiple clusters. AZs within a region are interconnected using high-speed optical fibers to allow you to build cross-AZ high-availability systems.

  • Project

    Projects group and isolate resources (including compute, storage, and network resources) across physical regions. A default project is provided for each region, and subprojects can be created under each default project. Users can be granted permissions to access all resources in a specific project. If you need more refined access control, create subprojects under a default project and create resources in subprojects. Then you can assign users the permissions required to access only the resources in the specific subprojects.

    Figure 1 Project isolation model