Before You Start

Welcome to Direct Connect API Reference. Direct Connect allows you to connect your on-premises data center to the cloud over a dedicated network connection that features stable performance, high transmission speed, low network latency, and secure data transmission. Direct Connect allows you to maximize legacy IT facilities and leverage cloud services to build a flexible, scalable hybrid cloud computing environment.

This document describes how to use application programming interfaces (APIs) to perform operations on Direct Connect resources, such as creating, querying, modifying, or deleting connections. For details about all supported operations, see API Overview.

Before you access Direct Connect by calling APIs, get yourself familiar with product concepts. For details, see Service Overview.

API Calling

Direct Connect supports Representational State Transfer (REST) APIs that can be called using HTTPS. For details, see Calling APIs.

Endpoints

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

Constraints

The number of Direct Connect resources that you can create is determined by your quotas. To view or increase the quotas, see Notes and Limitations in the Direct Connect User Guide.

For more constraints, see API description.

Glossary

Account
An account is created upon successful signing up. 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 Availability Zone (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 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 add resources to 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.