Help Center/ Server Migration Service/ API Reference/ Before You Start
Updated on 2024-07-17 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 or public clouds to Elastic Cloud Servers (ECSs) on Huawei Cloud.

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.

Endpoints

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

The following table lists SMS endpoints. Select a desired one based on the service requirements.

Table 1 SMS endpoint

Region Name

Region Code

Endpoint

AP-Singapore

ap-southeast-3

sms.ap-southeast-3.myhuaweicloud.com

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).

    API authentication requires information such as the account name, username, and password.

  • Region

    Regions are divided based on geographical location and network latency. Public services, such as Elastic Cloud Server (ECS), Elastic Volume Service (EVS), Object Storage Service (OBS), Virtual Private Cloud (VPC), Elastic IP (EIP), and Image Management Service (IMS), are shared within a same region. Regions are classified into universal regions and dedicated regions. A universal region provides universal cloud services for common tenants. A dedicated region provides specific services for specific tenants.

    For details, see Region and AZ.

  • AZ

    An AZ comprises of one or more physical data centers equipped with independent ventilation, fire, water, and electricity facilities. Compute, network, storage, and other resources in an AZ 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

    A project corresponds to a region. Default projects are defined to a group and have physically isolated resources (including computing, storage, and network resources) across regions. Users can be granted permissions in a default project to access all resources in the region under their accounts. 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
  • Enterprise project

    Enterprise projects group and manage resources across regions. Resources in different enterprise projects are logically isolated. An enterprise project can contain resources of multiple regions, and resources can be added to or removed from enterprise projects.

    For details about enterprise projects and about how to obtain enterprise project IDs, see Enterprise Management User Guide.