Updated on 2023-11-17 GMT+08:00

API Overview

VPC APIs include both native OpenStack APIs and extension APIs.

A combination of these two types of APIs allows you to use all functions provided by the VPC service. If a function involves both native OpenStack APIs and extension VPC APIs, use extension VPC APIs preferentially.

VPC APIs

Table 1 API description

Type

Description

Virtual Private Cloud

APIs for creating, querying, updating, and deleting VPCs

Subnet

APIs for creating, querying, updating, and deleting subnets

Quota

API for querying quota values

Private IP Address

APIs for assigning, querying, and releasing private IP addresses

Security Group

  • APIs for creating, querying, and deleting security groups
  • APIs for creating, querying, and deleting security group rules

Port

APIs for creating, querying, updating, and deleting ports

VPC Peering Connection

  • APIs for creating, querying, updating, and deleting VPC peering connections
  • APIs for accepting and rejecting VPC peering connection requests

VPC Route

APIs for creating, querying, and deleting VPC routes

VPC Tag Management

  • APIs for adding tags to VPCs, as well as querying and deleting VPC tags
  • APIs for adding tags to subnets as well as querying and deleting subnet tags

VPC Flow Log

APIs for creating, querying, updating, and deleting VPC flow logs

This type of APIs is now available in CN North-Beijing4, CN East-Shanghai1, CN South-Guangzhou, CN Southwest-Guiyang1, CN-Hong Kong, AP-Bangkok, AP-Singapore, LA-Mexico City2, and AF-Johannesburg.

VPC v3 APIs

Table 2 API description

Type

Description

VPC v3

  • APIs for querying and editing secondary CIDR blocks.
  • This type of APIs is now available in CN North-Beijing1, CN North-Beijing2, CN North-Beijing4, CN North-Ulanqab1, CN East-Shanghai1, CN East-Shanghai2, CN South-Guangzhou, CN South-Shenzhen, CN Southwest-Guiyang1, CN-Hong Kong, AP-Bangkok, AP-Singapore, AP-Jakarta, TR-Istanbul, AF-Johannesburg, LA-Mexico City1, LA-Mexico City2, LA-Sao Paulo1, and LA-Santiago.

Security Groups

  • APIs for creating, querying, updating, and deleting security groups.
  • This type of APIs is now available in CN North-Beijing1, CN North-Beijing2, CN North-Beijing4, CN North-Ulanqab1, CN East-Shanghai1, CN East-Shanghai2, CN South-Guangzhou, CN South-Shenzhen, CN Southwest-Guiyang1, CN-Hong Kong, AP-Bangkok, AP-Singapore, AP-Jakarta, TR-Istanbul, AF-Johannesburg, LA-Mexico City1, LA-Mexico City2, LA-Sao Paulo1, and LA-Santiago.

Security Group Rule

  • APIs for creating, querying, and deleting security group rules.
  • This type of APIs is now available in CN North-Beijing1, CN North-Beijing2, CN North-Beijing4, CN North-Ulanqab1, CN East-Shanghai1, CN East-Shanghai2, CN South-Guangzhou, CN South-Shenzhen, CN Southwest-Guiyang1, CN-Hong Kong, AP-Bangkok, AP-Singapore, AP-Jakarta, TR-Istanbul, AF-Johannesburg, LA-Mexico City1, LA-Mexico City2, LA-Sao Paulo1, and LA-Santiago.

IP Address Group

  • APIs for creating, querying, updating, and deleting IP address groups.
  • This type of APIs is now available in CN North-Beijing1, CN North-Beijing2, CN North-Beijing4, CN North-Ulanqab1, CN East-Shanghai1, CN East-Shanghai2, CN South-Guangzhou, CN South-Shenzhen, CN Southwest-Guiyang1, CN-Hong Kong, AP-Bangkok, AP-Singapore, AP-Jakarta, TR-Istanbul, AF-Johannesburg, LA-Mexico City1, LA-Mexico City2, LA-Sao Paulo1, and LA-Santiago.

Supplementary Network Interface

  • APIs for creating, querying, updating, and deleting supplementary network interfaces.
  • This type of APIs is now available in CN North-Beijing4, CN North-Beijing2, CN East-Shanghai1, CN East-Shanghai2, CN South-Guangzhou, CN Southwest-Guiyang1, CN-Hong Kong, AP-Singapore, AP-Jakarta, LA-Mexico City2, and TR-Istanbul.

Network ACL

  • APIs for creating, querying, updating, and deleting network ACLs.
  • This type of APIs is now available in CN North-Beijing4, CN East-Shanghai1, CN South-Guangzhou, CN South-Shenzhen, CN Southwest-Guiyang1, and AP-Singapore.

Ports

  • APIs for adding a port to or removing a port from a security group.
  • This type of APIs is now available in CN North-Beijing4, CN East-Shanghai1, CN South-Guangzhou, CN South-Shenzhen, CN Southwest-Guiyang1, AP-Bangkok, and CN-Hong Kong.

Native OpenStack APIs

Table 3 Native OpenStack APIs

Type

Description

API Version Information

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

Port

APIs for creating, querying, updating, and deleting ports

Network

APIs for creating, querying, updating, and deleting networks

Subnet

APIs for creating, querying, updating, and deleting subnets

Router

APIs for creating, querying, updating, and deleting routers

Network ACL

  • APIs for creating, updating, and releasing network ACLs
  • APIs for creating, updating, deleting, and querying network ACL rules.
  • APIs for creating, updating, deleting, and querying network ACL policies

Security Group

  • APIs for creating, querying, updating, and deleting security groups
  • APIs for creating, querying, and deleting security group rules