API Overview

APIs provided by the EIP service include native OpenStack APIs and EIP APIs.

A combination of these two types of APIs allows you to use all functions provided by the EIP service.

Enterprise project users can only use EIP APIs. For details about API permissions, see Permissions Policies and Supported Actions.

EIP APIs

Table 1 EIP APIs

Type

Description

Elastic IP

APIs for assigning, querying, updating, and releasing EIPs

Bandwidth

APIs for querying and updating bandwidth

Bandwidth (V2.0)

  • APIs for assigning and deleting shared bandwidth
  • APIs for adding an EIP to or removing an EIP from a shared bandwidth

Quota

API for querying quota values

EIP Tag Management

APIs for adding tags to EIPs as well as querying and deleting EIP tags

Currently, this type of API is available only in regions CN North-Beijing4, CN East-Shanghai1, CN East-Shanghai2, and CN Southwest-Guiyang1.

Native OpenStack APIs

Table 2 Native OpenStack APIs

Type

Description

API Version Information

APIs for querying all available API versions and displaying the results in pages.

Floating IP Address

APIs for assigning, querying, updating, and releasing floating IP addresses