API overview-Virtual Private Cloud(VPC)-阿里云帮助中心

API standard and pre-built SDKs in multi-language

The OpenAPI specification of this product (Vpc/2016-04-28) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.

Custom signature

If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).

Before you begin

An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.

VPC

API	Title	Description
CreateVpc	CreateVpc	Creates a virtual private cloud (VPC).
GrantInstanceToCen	GrantInstanceToCen	Grants permissions to a CEN instance.
AssociateVpcCidrBlock	AssociateVpcCidrBlock	Adds a secondary CIDR block to a virtual private cloud (VPC).
AllocateVpcIpv6Cidr	AllocateVpcIpv6Cidr	Reserves an IPv6 CIDR block.
DeleteVpc	DeleteVpc	Deletes a virtual private cloud (VPC).
RevokeInstanceFromCen	RevokeInstanceFromCen	Revokes the permissions granted to a Cloud Enterprise Network (CEN) instance on a network instance.
UnassociateVpcCidrBlock	UnassociateVpcCidrBlock	Removes a secondary CIDR block from a virtual private cloud (VPC).
ModifyVpcAttribute	ModifyVpcAttribute	Modifies the name and description of a virtual private cloud (VPC).
DescribeVpcs	DescribeVpcs	Queries virtual private clouds (VPCs).
DescribeVpcAttribute	DescribeVpcAttribute	Queries the configuration of a virtual private cloud (VPC).
DescribeGrantRulesToCen	DescribeGrantRulesToCen	Queries cross-account authorization on virtual private clouds (VPCs), virtual border routers (VBRs), and Cloud Connect Network (CCN) instances.

Router

API	Title	Description
DescribeVRouters	DescribeVRouters	Queries vRouters in a region.

vSwitch

API	Title	Description
ModifyVSwitchCidrReservationAttribute	Modify the name and description of a reserved CIDR block for a vSwitch	Modify the name and description of a reserved CIDR block for a vSwitch.
CreateDefaultVSwitch	CreateDefaultVSwitch	Creates a default vSwitch.
DeleteVSwitch	DeleteVSwitch	Deletes a vSwitch.
ModifyVSwitchAttribute	ModifyVSwitchAttribute	Modifies the name, description, and IPv6 settings of a vSwitch.
DescribeVSwitches	DescribeVSwitches	Queries the information about available vSwitches that are used for an internal network.
DescribeVSwitchAttributes	DescribeVSwitchAttributes	Queries the detailed information about a vSwitch.
DeleteVSwitchCidrReservation	DeleteVSwitchCidrReservation	Deletes a reserved CIDR block of a vSwitch.

Route table

API	Title	Description
CreateRouteEntry	Create a custom route entry	Creates a custom route entry on a vRouter or Virtual Border Router (VBR).
CreateRouteEntries	CreateRouteEntries	Adds custom routes in a batch to the route table of a VPC router.
CreateRouteTable	CreateRouteTable	Creates a custom route table.
DeleteRouteEntry	DeleteRouteEntry	Deletes a route entry from a route table of a VRouter or virtual border router (VBR).
DeleteRouteEntries	DeleteRouteEntries	Deletes multiple custom route entries at a time.
ModifyRouteTableAttributes	ModifyRouteTableAttributes	Modifies the name and description of a route table.
ModifyRouteEntry	Modify the name, description, or next hop of a custom route entry	Calls ModifyRouteEntry to modify the name, description, and next hop of a custom route entry.
DescribeRouteTables	DescribeRouteTables	Queries route tables.
DescribeRouteEntryList	DescribeRouteEntryList	Queries information about route entries in a route table.
ListVpcPublishedRouteEntries	Query VPC Route Publishing Status	Query the route publishing status
PublishVpcRouteEntries	Publish VPC Routes	Publish VPC Routes
ListGatewayRouteTableEntries	ListGatewayRouteTableEntries	Queries route entries of a gateway route table.

Prefix list

API	Title	Description
ModifyVpcPrefixList	ModifyVpcPrefixList	Modifies the configuration of a prefix list.
GetVpcPrefixListAssociations	GetVpcPrefixListAssociations	Queries the resources that are associated with a prefix list.

DHCP

API	Title	Description
DetachDhcpOptionsSetFromVpc	DetachDhcpOptionsSetFromVpc	Disassociates a DHCP options set from a virtual private cloud (VPC).
GetDhcpOptionsSet	GetDhcpOptionsSet	Queries a DHCP options set.
ListDhcpOptionsSets	ListDhcpOptionsSets	Queries Dynamic Host Configuration Protocol (DHCP) options sets.

Flow log

API	Title	Description
CreateFlowLog	Create a flow log	Create a flow log.
ModifyFlowLogAttribute	ModifyFlowLogAttribute	Modifies the name and description of a flow log.
DescribeFlowLogs	Query Flow Logs	Query flow logs.

ACL

API	Title	Description
UpdateNetworkAclEntries	UpdateNetworkAclEntries	Updates the rules of a network access control list (ACL).

HaVip

API	Title	Description
CreateHaVip	CreateHaVip	Creates a high-availability virtual IP address (HaVip).
AssociateHaVip	AssociateHaVip	Associates a high-availability virtual IP address (HaVip) with an Elastic Compute Service (ECS) instance or an elastic network interface (ENI).
DeleteHaVip	DeleteHaVip	Deletes a high-availability virtual IP address (HaVip).
UnassociateHaVip	UnassociateHaVip	Disassociates a high-availability virtual IP address (HaVip) from an Elastic Compute Service (ECS) in a virtual private cloud (VPC) or from an elastic network interface (ENI).
ModifyHaVipAttribute	ModifyHaVipAttribute	Modifies the name and description of a high-availability virtual IP address (HaVip).
DescribeHaVips	DescribeHaVips	Queries HaVips in a region.

Traffic mirror

API	Title	Description
Filter rule	Filter rule
CreateTrafficMirrorFilterRules	CreateTrafficMirrorFilterRules	Creates an inbound or outbound rule for traffic mirror.
DeleteTrafficMirrorFilterRules	DeleteTrafficMirrorFilterRules	Deletes an inbound or outbound rule of a filter for traffic mirror.
UpdateTrafficMirrorFilterRuleAttribute	UpdateTrafficMirrorFilterRuleAttribute	Modifies the configuration of an inbound or outbound rule for traffic mirror.
Filter	Filter
CreateTrafficMirrorFilter	CreateTrafficMirrorFilter	Creates a filter for traffic mirror.
DeleteTrafficMirrorFilter	DeleteTrafficMirrorFilter	Deletes a filter of traffic mirror.
UpdateTrafficMirrorFilterAttribute	UpdateTrafficMirrorFilterAttribute	Modifies the configuration of a filter for traffic mirror.
ListTrafficMirrorFilters	ListTrafficMirrorFilters	Queries filters for traffic mirror.
Session	Session
AddSourcesToTrafficMirrorSession	AddSourcesToTrafficMirrorSession	Adds a traffic mirror source to a traffic mirror session.
CreateTrafficMirrorSession	CreateTrafficMirrorSession	Creates a traffic mirror session.
DeleteTrafficMirrorSession	DeleteTrafficMirrorSession	Deletes a traffic mirror session.
UpdateTrafficMirrorSessionAttribute	UpdateTrafficMirrorSessionAttribute	Modifies the configuration of a traffic mirror session.
ListTrafficMirrorSessions	ListTrafficMirrorSessions	Queries the details of a traffic mirror session.
RemoveSourcesFromTrafficMirrorSession	RemoveSourcesFromTrafficMirrorSession	Deletes a traffic mirror source from a traffic mirror session.
OpenTrafficMirrorService	OpenTrafficMirrorService	Enables traffic mirror.
GetTrafficMirrorServiceStatus	GetTrafficMirrorServiceStatus	Queries the status of the traffic mirror feature.

Route Target Group

API	Title	Description
SwitchActiveRouteTarget	SwitchActiveRouteTarget	Switch Active and Standby For RouteTargetGroup.
UpdateRouteTargetGroup	Update a route target group	Updates the information of a route target group instance, including the name, description, and disabled members.
ListRouteTargetGroups	ListRouteTargetGroups	Batch query for route target groups
GetRouteTargetGroup	GetRouteTargetGroup	Get the route target group
DeleteRouteTargetGroup	DeleteRouteTargetGroup	Delete Route Target Group
CreateRouteTargetGroup	Create a route target group	Creates a route target group instance.

IPv6 gateway

API	Title	Description
CreateIpv6EgressOnlyRule	Add an egress-only rule for an IPv6 address	You can create an egress-only rule to allow ECS instances in a VPC with an IPv6 CIDR block to initiate outbound access to IPv6 endpoints of clients, while preventing IPv6 endpoints of clients from accessing ECS instances in the VPC over the Internet. Invoke CreateIpv6EgressOnlyRule to add an egress-only rule for an IPv6 address.
DeleteIpv6Gateway	DeleteIpv6Gateway	Deletes an IPv6 gateway.
DescribeIpv6Gateways	Query created IPv6 gateways	Invoke the DescribeIpv6Gateways API to query IPv6 gateways created in a specific region.

Tag

API	Title	Description
DescribeTags	DescribeTags	Queries tags that meet the specified filter conditions.
DescribeTagKeys	DescribeTagKeys	Queries tag keys.

Router interface

API	Title	Description
DeleteExpressConnect	DeleteExpressConnect	Deletes a Express Connect instance, including the initiator and acceptor.

VPC gateway endpoint

API	Title	Description
ListVpcGatewayEndpoints	ListVpcGatewayEndpoints	Queries gateway endpoints.