Help Center/ Cloud Phone Host/ API Reference/ Before You Start
Updated on 2024-08-09 GMT+08:00
View PDF
Share

Before You Start

Welcome to Cloud Phone Host API Reference. Cloud Phone Host (CPH) provides you with cloud phone servers that are virtualized from Huawei Cloud Bare Metal Servers (BMSs). They run native Android and have the functions of virtual phones.

You can use APIs described in this document to manage cloud phone servers and cloud phones, such as purchasing a cloud phone server, querying cloud phones, querying applications deployed on cloud phones, modifying shared bandwidth, and restarting cloud phones. For details about all supported operations, see API Overview.

If you plan to access CPH through an API, ensure that you are familiar with CPH 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 endpoints of CPH, see Regions and Endpoints.

Concepts

  • Account

    An account is created upon successful registration with Huawei Cloud. 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 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 the 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 cooling, fire extinguishing, moisture-proof, and electricity facilities. Computing, 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 group and physically isolate resources (including computing, storage, and network resources) across regions. Users can be granted permissions in a default project to access all resources under their accounts in the region associated with the 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 isolating 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.