Help Center/ ROMA Connect/ API Reference/ Before You Start
Updated on 2025-03-26 GMT+08:00
View PDF
Share

Before You Start

Overview

ROMA Connect is a full-stack application & data integration platform. It provides message, data, API, and device integration to simplify enterprise cloudification and support cross-regional integration for cloud and on-premises applications, helping enterprises achieve digital transformation.

You can use APIs provided in this document to perform operations on ROMA Connect, such as creating, deleting, and modifying APIs, and adding custom backends. For details about all supported operations, see API Overview.

Before calling a ROMA Connect API, ensure that you have fully understood the concepts related to ROMA Connect. For details, see Service Overview.

API Calling

ROMA Connect supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see Calling APIs.

Endpoints

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

Notes and Constraints

  • The number of ROMA Connect resources that you can create is determined by your quota. For details, see Quota Limits.
  • For more constraints, see the description of each API.

Basic Concepts

  • Account

    An account is created upon successful registration with the cloud platform. 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 and 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.

  • IAM user

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

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

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

  • Availability Zone (AZ)

    An AZ comprises 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 (HA) systems.

  • Project

    A project corresponds to a region. Projects group and isolate resources (including compute, storage, and network resources) across physical regions. Users can be granted permissions in a default project to access all resources in the region associated with the project. For more refined access control, create subprojects under a project and purchase resources in the subprojects. Users can then be assigned permissions to access only specific resources in the subprojects.

    Figure 1 Project isolation
  • Enterprise Project

    Enterprise projects group and logically isolate resources. An enterprise project can contain resources in multiple regions, and resources can be transferred between enterprise projects.

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