Selecting an API Version

There are three versions of APIs, including v2.0, v2, and v3.

APIs v2.0 and v2 are applicable to shared load balancers. The main version is v2.0. APIs of this version are used in enterprise projects.

For details about the APIs and their functions, see API Overview. To meet your requirements for interconnecting with OpenStack, some APIs v2.0 are compatible with OpenStack API v2. The functions of these APIs are similar and their styles are slightly different.

APIs v3 are designed for dedicated load balancers. The performance of a dedicated load balancer is not affected by other load balancers. In addition, there are a wide range of specifications available for selection. Dedicated load balancers feature high performance, high availability, and ultra-security, support multiple protocols, and allow you to customize flexible traffic distribution policies. Dedicated load balancers also support the enterprise project function.

Refer to the following suggestions when you select APIs of different versions:

• If you require compatibility with OpenStack, you are advised to select APIs v2.0.
• If you use native OpenStack APIs to create Virtual Private Clouds (VPCs) and Elastic Cloud Servers (ECSs), you are advised to use them together with APIs v2.0.
• If you have enabled the enterprise project function, you are advised to select APIs v2.
• If you require higher performance or more flexible load balancing policies, you are advised to use API v3 APIs.