Help Center> Elastic Cloud Server> API Reference> API Overview
View PDF

API Overview

APIs for ECS include native OpenStack APIs and ECS APIs. ECS APIs are recommended.

ECS APIs

Table 1 ECS APIs

Type

Description

Lifecycle management

Create, delete, or query ECSs.

Status management

Modify ECS specifications; reinstall or change the ECS OS; automatically recover ECSs.

Batch operations

Start, restart, stop, or modify ECSs in a batch.

Flavor management

Query details about flavors and extended flavor information.

NIC management
  • Add or delete ECS NICs in a batch.
  • Bind or unbind a private IP address to or from an ECS NIC.

Disk management

Attach, detach, or query ECS disks.

Metadata management

Update ECS metadata and delete specified ECS metadata.

Tenant quota management

Query the quotas of a tenant, including the quota limit and used quotas.

Task status management

Query asynchronous API execution status, such as creating or deleting ECSs, performing batch operations on ECSs, or performing operations on NICs.

Tag management

Create, delete, or query ECS D2 tags.

Tags can be added or deleted in a batch.

Password management

Reset the password for logging in to an ECS with a few clicks.

FPGA logical file management

Register, delete, or query FPGA images. This API is used for FPGA-accelerated ECSs.

ECS group management

Create or delete an ECS group, add an ECS to an ECS group, or delete an ECS from an ECS group.

Native OpenStack APIs

Table 2 Native OpenStack APIs

Type

Description

API version query
  • Query all API versions.
  • Query a specified API version.

Lifecycle management

Create, delete, modify, or query ECSs.

Status management

Start, stop, restart, lock, or unlock ECSs; modify ECS specifications; roll back ECS specifications modification.

Network management

Query ECS tenants or networks.

Image management

Delete or query images.

This image management API has been discarded. Use the IMS API.

Security group management

Add, remove, query, create, update, or delete security groups and security group rules.

Flavor management

Query ECS flavors and details.

NIC management

Add, delete, or query ECS NICs.

Disk management

Attach, detach, or query ECS disks.

Metadata management

Update, set, delete, query, obtain, or modify ECS metadata.

Tenant quota management

Query tenant quotas.

Key and password management

Query, create, or delete SSH keys.

Floating IP address management

Allocate, release, create, query, or delete floating IP addresses.

This floating IP address management API has been discarded. Use the network service API.

ECS group management

Create, query, or delete ECS groups.

ECS operation management

Query ECS operations or a specified operation by request ID.

ECS console management

Obtain ECS management console logs.

Snapshot management

Create, query, or delete snapshots.

The snapshot management API has been discarded. Use the storage service API.

AZ

Show AZs.

Tag management

Create, delete, or query ECS D1 tags.