• API White Paper

  1. Help Center
  2. API White Paper
  3. API Reference
  4. Open Telekom Cloud API Overview
  5. Open Telekom Cloud API Overview
  6. Open Telekom Cloud API Capabilities

Open Telekom Cloud API Capabilities

Open Telekom Cloud provides enterprise users with APIs for each released service. With the APIs, users can interconnect cloud management tools with each service to enable automatic management and use of public cloud resources, which greatly improves the efficiency in managing IT infrastructure. API capabilities refer to API callings of all cloud services provided by Open Telekom Cloud. All APIs comply with the RESTful API specifications and are accessed using Hypertext Transfer Protocol Secure (HTTPS). Open IaaS APIs are provided, including standard OpenStack APIs (Nova, Cinder, and Neutron APIs) and combined and encapsulated APIs (such as VPC APIs).

The Open Telekom Cloud API architecture provides two types of APIs:

  • Only publish non-admin APIs and native APIs through API Gateway for Nova, Cinder, Glance, and KeyStone.
  • Only publish combined APIs based on native OpenStack APIs to carry out the combined API package, to reduce the complexity, such as VPC API and extended ECS/EVS APIs.


An Elastic Cloud Server (ECS) is a computing server consisting of the CPU, memory, image, and EVS disks. It can be obtained at any time and scaled on demand. With ECS APIs, users can perform operations on ECS resources.


Auto Scaling (AS) uses preset policies to automatically scale service resources up and down based on user service requirements. Tenants can configure scheduled, periodic, and monitoring policies to enable AS to automatically increase or decrease the number of ECS instances, ensuring stable and healthy running of services. With AS APIs, users can perform operations on these resources.


Image Management Service (IMS) provides self-service capabilities to flexibly use a public or private image to apply for an ECS. With IMS APIs, users can perform operations on IMS resources.


Elastic Volume Service (EVS) is a scalable virtual block storage service that is based on the distributed architecture. Tenants can perform operations on an EVS disk without interrupting disk services. The method for using an EVS disk is the same as that for using a hard disk on traditional servers. EVS disks provide high data reliability and I/O throughput and are easy to use. Therefore, it can be used by file systems, databases, and other system software or applications that require native block storage devices. With EVS APIs, users can perform operations on EVS resources.


Volume Backup Service (VBS) backs up data on EVS disks and uses the backups to restore original data, ensuring user data accuracy and security. With VBS APIs, users can perform operations on VBS resources.


Object Storage Service (OBS) is an object-based massive cloud storage service that provides tenants with massive, low-cost, highly reliable, and secure data storage capabilities. With OBS APIs, users can perform operations on OBS resources.


Virtual Private Cloud (VPC) allows you to provision a logically isolated virtual network environment on Open Telekom Cloud that you define and manage, improving security of resources in a public cloud and simplifying network deployment.

Tenants have complete control over their virtual network environment, including network creation and DHCP configuration. Tenants can use security groups to improve security of their network environments. Tenants can apply for a public IP address to connect a VPC with the public network or create a VPN to connect the VPC with a traditional data center, implementing smooth application migration to the cloud. With VPC APIs, users can perform operations on VPC resources.


Elastic Load Balance (ELB) is a service that automatically distributes access traffic to multiple ECSs to balance load. It enables tenants to achieve high fault tolerance in their applications and expand application service capabilities. With ELB APIs, users can perform operations on ELB resources.

Cloud Eye API

Cloud Eye is an open monitoring platform that provides monitoring, alarm reporting, and alarm notification for resources in real time. With Cloud Eye APIs, users can perform operations on Cloud Eye resources.


Identity and Access Management (IAM) provides a user management mechanism designed for enterprises. It allocates different resources and operation rights for enterprise members, so that they can use an access key to access public cloud resources through open APIs. With IAM APIs, users can perform operations on IAM resources.


Anti-DDoS uses professional anti-DDoS devices to protect users' applications from DDoS attacks, such as CC, SYN flood, and UDP flood. Tenants can configure the threshold for DDoS prevention based on the rented bandwidth and service model. After the system detects a DDoS attack, it notifies the tenant to guard against the attack.


Simple Message Notification (SMN) sends messages to subscription endpoints through SMS messages, emails, HTTP servers, or HTTPS servers. With SMN APIs, users can send messages to subscription endpoints easily and conveniently.


Cloud Container Engine (CCE), built on open-source container technologies, such as Kubernetes or Docker, provides a wide range of container services, including container cluster management, application orchestration deployment, monitoring, automatic capacity expansion, and private image repository. CCE provides the following commercial enhancements based on Kubernetes:

  • Multi-cluster management
  • Container application life cycle management
  • Container application monitoring
  • Container application log management
  • Automatic capacity expansion and O&M
  • Container application templates and orchestration
  • Platform security hardening


Key Management Service (KMS) provides a centralized key management service. Integrated with the static data storage service on the cloud platform, KMS uses international standard password algorithms to encrypt tenant data, preventing unauthorized access and ensuring data security.

Workspace API

Workspace is a desktop computing service hosted on the cloud. It provides Windows desktops as cloud services for users. Using Workspace, users can easily configure cloud-based desktops and access the virtual desktops to use desired documents and applications from any devices, including Windows and Mac computers, iPads, iPhones, Android smart terminals, and thin clients (TCs).


Cloud Trace Service (CTS) records cloud service operation requests initiated from the public cloud management console or open APIs and responses to the requests. Tenants can query, audit, and trace back the operation records. In addition, tenants can store the operation records to the OBS buckets.


Dedicated Host (DeH) allows tenants to apply for dedicated physical hosts for ECSs so that the tenants can run their ECSs on the dedicated hosts for better isolation. Tenants can apply for different types of dedicated hosts to run ECSs with different specifications. In addition, tenants can use their own license (BYOL) to migrate existing licenses to the cloud for cost reduction.

Tenants can use DeH APIs to perform lifecycle management on dedicated hosts, including applying for, releasing, and monitoring dedicated hosts. Tenants can use the ECS creation APIs to deploy ECSs on a dedicated host.


Distributed Message Service (DMS) is a message middleware service using highly available distributed cluster technologies. It features large scale, high availability, highly concurrent access, scalability, and full hosting. DMS enables cloud applications to decouple from each other, making it a cost-effective solution. Tenants can use message queue management APIs to create and delete message queues.


Migration as a Service (MaaS) enables tenants to migrate data in OBS buckets. With MaaS APIs, tenants can migrate object data from S3 to OBS and query and control the migration process.


Elastic Access Bandwidth (EAB) provides tenants with hourly bandwidth access and elastic bandwidth adjustment policies, maximizing bandwidth usage efficiency and reducing enterprise costs. EAB provides APIs for tenants to manage bandwidth calendars, sites, and traffic rates as well as monitor bandwidth. Tenants can use APIs to provision the EAB service or manage bandwidth calendar.


Relational Database Service (RDS) is an online relational database service based on a cloud computing platform. RDS is reliable, scalable, secure, and easy to manage. Tenants can use the service immediately after purchasing it.


Bare Metal Server (BMS) is a physical server dedicated for individual tenants. It provides remarkable computing performance and stability for running key applications. With BMS APIs, users can apply for BMSs and manage the BMS lifecycle in the same way as they do to ECSs.


MapReduce Service (MRS) provides users with a complete controllable, enterprise-class, big data cloud service, ensuring the smooth running of big data components, such as Hadoop, Spark, HBase, Kafka, and Storm.


A virtual private network (VPN) establishes an encrypted communication tunnel between a remote user and a Virtual Private Cloud (VPC). With VPN, you can connect to a VPC and access service resources in it.


Tag Management Service (TMS) enables users to tag and categorize cloud services across regions, efficiently integrating resource billing and management.


Data Pipeline Service (DPS) is a web service running on the public cloud. It enables users to easily automate the movement and transformation of data between different services.