API overview - Virtual Private Cloud - Alibaba Cloud Documentation Center

API standards and multilingual preset SDKs

The OpenAPI of this product (Vpc/2016-04-28) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.

Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.

Custom signature scenarios

If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.

Account and security preparation

Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.

Virtual private cloud (VPC)

API	Title	Description
CreateVpc	Create a VPC	Creates a virtual private cloud (VPC).
CreateDefaultVpc	Create a default VPC	Creates a default virtual private cloud (VPC).
GrantInstanceToCen	Grant permissions to a CEN instance	Grants permissions to a Cloud Enterprise Network (CEN) instance.
AssociateVpcCidrBlock	Add a secondary CIDR block to a VPC	Adds a secondary CIDR block to a VPC.
AllocateVpcIpv6Cidr	Reserve a specified iPv6 CIDR block	Reserves a specified IPv6 CIDR block.
DeleteVpc	Delete a VPC	Deletes a virtual private cloud (VPC).
RevokeInstanceFromCen	Revoke authorization of a network instance for a CEN instance	Revokes the authorization of a network instance for a specified Cloud Enterprise Network (CEN) instance.
UnassociateVpcCidrBlock	Delete a secondary CIDR block from a VPC	Calls the UnassociateVpcCidrBlock operation to delete a secondary CIDR block from a VPC.
ModifyVpcAttribute	Modify the configuration of a specified VPC	Modifies the configuration of a specified VPC.
EnableVpcClassicLink	Enable classicLink	Enables ClassicLink.
DisableVpcClassicLink	Disable classicLink	Shuts down ClassicLink.
DeletionProtection	Instance deletion protection	Sets the deletion protection feature for an instance.
DescribeVpcs	Query created vPCs	Queries created VPCs.
DescribeVpcAttribute	Query the configuration of a specified VPC	Queries the configuration of a specified VPC.
DescribeGrantRulesToCen	Query cross-account authorization information of CEN	Queries the cross-account authorization information of a specified network instance (VPC, VBR, or CCN) in Cloud Enterprise Network (CEN).

vRouter

API	Title	Description
ModifyVRouterAttribute	Modify the name and description of a vRouter	Modifies the name and description of a vRouter.
DescribeVRouters	Query vRouters in a specified region	Queries the list of vRouters in a specified region.

Virtual switch

API	Title	Description
ListVSwitchCidrReservations	Query reserved vSwitch CIDR blocks	Queries reserved CIDR blocks for a vSwitch.
CreateVSwitchCidrReservation	Create reserved vSwitch CIDR block	Creates a reserved CIDR block for a vSwitch.
GetVSwitchCidrReservationUsage	Query the usage of a reserved CIDR block for a vSwitch	Queries the usage of a reserved CIDR block for a vSwitch.
ModifyVSwitchCidrReservationAttribute	Modify the name and description of a reserved vSwitch CIDR block	Modifies the name and description of a reserved CIDR block for a vSwitch.
CreateVSwitch	Create a vSwitch	Creates a vSwitch.
CreateDefaultVSwitch	Create a default vSwitch	Creates a default vSwitch by calling the CreateDefaultVSwitch operation.
CheckCanAllocateVpcPrivateIpAddress	Check private IP address availability in a vSwitch	Checks whether a private IP address in a vSwitch is available.
DeleteVSwitch	Delete a vSwitch	Invokes the DeleteVSwitch operation to delete a vSwitch.
ModifyVSwitchAttribute	Modify the configuration of a specified vSwitch	Modifies the configuration of a specified vSwitch.
DescribeVSwitches	Query networkable information	Queries networkable information. Internal networking is performed by vSwitch.
DescribeVSwitchAttributes	Query the configuration of a specified vSwitch	Queries the configuration information of a specified vSwitch by calling the DescribeVSwitchAttributes operation.
DeleteVSwitchCidrReservation	Delete reserved vSwitch CIDR block	Deletes a reserved vSwitch CIDR block.

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	Create custom route entries in a batch	Creates custom route entries in a route table of a VPC vRouter in a batch.
CreateRouteTable	Create a custom route table	Creates a custom route table.
AssociateRouteTable	Associate a route table with a vSwitch	Associates a custom route table with a vSwitch in the same VPC.
DeleteRouteEntry	Delete a custom route entry	Invokes the DeleteRouteEntry operation to delete a route from the route table of a VPC vRouter or Virtual Border Router (VBR).
DeleteRouteEntries	Batch delete custom route entries	Calls DeleteRouteEntries to batch delete custom route entries.
DeleteRouteTable	Delete a custom route table	Deletes a custom route table.
UnassociateRouteTable	Disassociate a route table from a vSwitch	Disassociates a route table from a vSwitch by calling the UnassociateRouteTable operation.
ModifyRouteTableAttributes	Modify the name and description of a route table	Modifies the name or description of a route table, or specifies whether to receive dynamic routes.
ModifyRouteEntry	Modify a custom route entry	Invokes the ModifyRouteEntry operation to modify custom route entry name, description, and route next hop.
GetVpcRouteEntrySummary	Query route type details	Queries the details of route types by calling the GetVpcRouteEntrySummary operation.
DescribeRouteTables	Query route tables	Queries route tables.
DescribeRouteEntryList	Query route entries	Queries a list of routes.
DescribeRouteTableList	Query route tables	Queries a list of route tables by calling the DescribeRouteTableList operation.
ListVpcPublishedRouteEntries	Query VPC route publish status	Queries the route publish status.
PublishVpcRouteEntries	Publish VPC routes	Publishes VPC routes to external components.
WithdrawVpcPublishedRouteEntries	Withdraw VPC published route entry	Withdraws a VPC published routing entry.
ListGatewayRouteTableEntries	Query gateway route table entries	Queries the route entries in a gateway route table.
AssociateRouteTableWithGateway	Associate a gateway route table with a gateway	Associates a gateway route table with an IPv4 gateway or IPv6 gateway instance in the same VPC by calling the AssociateRouteTableWithGateway operation.
DissociateRouteTableFromGateway	Disassociate a gateway route table from a gateway	Disassociates a gateway route table from an IPv4 gateway or IPv6 gateway instance.
UpdateGatewayRouteTableEntryAttribute	Modify the next hop type and next hop of a gateway route table	Modifies the next hop type and next hop of a gateway route table.

Prefix list

API	Title	Description
CreateVpcPrefixList	Create a prefix list	Creates a prefix list.
RetryVpcPrefixListAssociation	Retry delivery of the latest prefix list	Retries the delivery of the latest prefix list by calling the RetryVpcPrefixListAssociation operation.
DeleteVpcPrefixList	Delete a prefix list	Deletes a prefix list.
ModifyVpcPrefixList	Modify prefix list configuration	Modifies the configuration of a prefix list.
ListPrefixLists	Query prefix list information	Queries information about prefix lists.
GetVpcPrefixListAssociations	Query prefix list associations	Queries the associations of a prefix list.
GetVpcPrefixListEntries	Query information about a specified prefix list	Calls the GetVpcPrefixListEntries operation to query information about a specified prefix list.

DHCP options set

API	Title	Description
CreateDhcpOptionsSet	Create a DHCP options set	Creates a DHCP options set.
DeleteDhcpOptionsSet	Delete a DHCP options set	Deletes a DHCP options set.
AttachDhcpOptionsSetToVpc	Attach DHCP options set to VPC	Calls the AttachDhcpOptionsSetToVpc operation to attach a DHCP options set to a VPC.
DetachDhcpOptionsSetFromVpc	Disassociate a DHCP options set from a VPC	Disassociates a DHCP options set from a VPC.
ReplaceVpcDhcpOptionsSet	Change the DHCP options set associated with a VPC	Calls the ReplaceVpcDhcpOptionsSet operation to change the DHCP options set associated with a VPC.
UpdateDhcpOptionsSetAttribute	Modify DHCP options set configuration	Modifies the configuration of a DHCP options set.
GetDhcpOptionsSet	Query a created DHCP options set	Queries a created DHCP options set by calling the GetDhcpOptionsSet operation.
ListDhcpOptionsSets	Query created DHCP options sets	Queries a list of created DHCP options sets by calling the ListDhcpOptionsSets operation.

Flow log

API	Title	Description
OpenFlowLogService	Activate flow log service	Activates the flow log service.
CreateFlowLog	Create a flow log	Creates a flow log.
DeleteFlowLog	Delete a flow log	Deletes a flow log.
ModifyFlowLogAttribute	Modify the name and description of a flow log	Calls the ModifyFlowLogAttribute operation to modify the name and description of a flow log.
ActiveFlowLog	Activate a flow log	Calls the ActiveFlowLog operation to activate a flow log and start capturing traffic of the specified resource.
DeactiveFlowLog	Stop a flow log	Stops a flow log instance. After the flow log is stopped, traffic of the specified resource is no longer captured.
GetFlowLogServiceStatus	Query the activation status of the flow log service	Queries the activation status of the flow log service by calling the GetFlowLogServiceStatus operation.
DescribeFlowLogs	Query flow logs	Queries flow logs.

Network ACL

API	Title	Description
AssociateNetworkAcl	Associate a network ACL with a vSwitch	Attaches a network ACL to a vSwitch.
CreateNetworkAcl	Create a network ACL	Creates a network ACL.
CopyNetworkAclEntries	Copy network ACL rules	Calls the CopyNetworkAclEntries operation to copy network ACL rules.
DeleteNetworkAcl	Delete a network ACL	Deletes a network ACL.
UnassociateNetworkAcl	Disassociate a network ACL from a vSwitch	Disassociates a network ACL from a vSwitch by calling the UnassociateNetworkAcl operation.
ModifyNetworkAclAttributes	Modify network ACL attributes	Modifies the attributes of a network ACL.
UpdateNetworkAclEntries	Update network ACL rules	Invokes the UpdateNetworkAclEntries operation to update network ACL rules.
DescribeNetworkAclAttributes	Query network ACL details	Queries the details of a network ACL.
DescribeNetworkAcls	Query network ACL list	Queries a list of network ACLs by calling the DescribeNetworkAcls operation.

High-availability virtual IP address

API	Title	Description
CreateHaVip	Create a high-availability virtual IP address (HAVIP)	Creates a high-availability virtual IP address (HAVIP).
AssociateHaVip	Attach an HaVip to a VPC ECS instance	Invokes the AssociateHaVip operation to attach an HaVip to an ECS instance or elastic network interface (ENI) in a virtual private cloud (VPC).
DeleteHaVip	Delete a high-availability virtual IP address (HaVip)	Deletes a high-availability virtual IP address (HaVip).
UnassociateHaVip	Disassociate HaVip from a VPC ECS instance	Invokes the UnassociateHaVip operation to disassociate a high-availability virtual IP address (HaVip) from an ECS instance or network interface controller (NIC) in a virtual private cloud (VPC).
ModifyHaVipAttribute	Modify the name and description of a haVip	Modifies the name and description of a HaVip.
DescribeHaVips	Query haVips in a region	Queries high-availability virtual IP addresses (HaVips) in a specified region.

Traffic mirroring

API	Title	Description
Traffic mirror filter rule	Traffic mirror filter rule
CreateTrafficMirrorFilterRules	Create inbound or outbound traffic mirroring filter rules	Invokes the CreateTrafficMirrorFilterRules operation to create inbound or outbound rules for a traffic mirror filter.
DeleteTrafficMirrorFilterRules	Delete inbound or outbound rules of a traffic mirror filter	Invokes the DeleteTrafficMirrorFilterRules operation to delete inbound or outbound rules of a traffic mirror filter.
UpdateTrafficMirrorFilterRuleAttribute	Modify the configuration of a traffic mirroring filter rule	Invokes the UpdateTrafficMirrorFilterRuleAttribute operation to modify the configuration of an inbound or outbound rule of a traffic mirroring filter.
Traffic mirror filter	Traffic mirror filter
CreateTrafficMirrorFilter	Create a traffic mirror filter	Invokes the CreateTrafficMirrorFilter operation to create a traffic mirror filter.
DeleteTrafficMirrorFilter	Delete a traffic mirror filter	Invokes the DeleteTrafficMirrorFilter operation to delete a traffic mirror filter.
UpdateTrafficMirrorFilterAttribute	Modify the configuration of a traffic mirror filter	Invokes the UpdateTrafficMirrorFilterAttribute operation to modify the configuration of a traffic mirror filter.
ListTrafficMirrorFilters	Query traffic mirror filters	Queries traffic mirror filters.
Traffic mirror session	Traffic mirror session
AddSourcesToTrafficMirrorSession	Add traffic mirror sources to a traffic mirror session	Adds traffic mirror sources to a traffic mirror session by calling the AddSourcesToTrafficMirrorSession operation.
CreateTrafficMirrorSession	Create a traffic mirror session	Creates a traffic mirror session by calling CreateTrafficMirrorSession.
DeleteTrafficMirrorSession	Delete a traffic mirror session	Deletes a traffic mirror session.
UpdateTrafficMirrorSessionAttribute	Modify the configuration of a traffic mirror session	Modifies the configuration of a traffic mirror session.
ListTrafficMirrorSessions	Query traffic mirror session details	Queries the details of traffic mirror sessions.
RemoveSourcesFromTrafficMirrorSession	Remove traffic mirror sources from a traffic mirror session	Removes traffic mirror sources from a traffic mirror session.
OpenTrafficMirrorService	Activate the traffic mirroring feature	Activates the traffic mirroring feature.
GetTrafficMirrorServiceStatus	Query the status of the traffic mirroring feature	Queries the status of the traffic mirroring feature by calling the GetTrafficMirrorServiceStatus operation.

Route target group

API	Title	Description
SwitchActiveRouteTarget	Perform active/standby switchover for a route target group	Performs an active/standby switchover for a route target group.
UpdateRouteTargetGroup	Update a route target group	Updates the information of a route target group instance, including the name, description, and disabled members.
ListRouteTargetGroups	Query route target groups	Queries a list of route target groups.
GetRouteTargetGroup	Query a route target group	Retrieves information about a route target group instance.
DeleteRouteTargetGroup	Delete a route target group	Deletes a route target group instance.
CreateRouteTargetGroup	Create a route target group	Creates a route target group instance.

IPv6 gateway

API	Title	Description
AllocateIpv6Address	Create an iPv6 address	Invokes the AllocateIpv6Address operation to allocate a free IPv6 address or IPv6 prefix CIDR block. The address is not associated with any resource instance (such as a network interface controller (NIC) or Network Load Balancer (NLB)) and exists as an independent IPv6 address in the virtual private cloud (VPC).
ReleaseIpv6Address	Release an iPv6 address	Releases an IPv6 address that is not associated with an instance.
CreateIpv6Gateway	Create an iPv6 gateway	Creates an IPv6 gateway. An IPv6 gateway is used to control IPv6 network traffic for a virtual private cloud (VPC).
CreateIpv6EgressOnlyRule	Create an iPv6 egress-only rule for an iPv6 address	Creates an IPv6 egress-only rule for an IPv6 address by calling CreateIpv6EgressOnlyRule. You can create an egress-only rule to allow ECS instances in a VPC with an IPv6 CIDR block to proactively access IPv6 endpoints on the client side, while preventing IPv6 endpoints on the client side from accessing ECS instances in the VPC over the Internet.
DeleteIpv6Gateway	Delete an iPv6 gateway	Deletes an IPv6 gateway.
DeleteIpv6EgressOnlyRule	Delete an iPv6 egress-only rule	Deletes an IPv6 egress-only rule.
DeleteIpv6InternetBandwidth	Delete internet bandwidth	Deletes the Internet bandwidth of an IPv6 address by calling the DeleteIpv6InternetBandwidth operation.
ModifyIpv6InternetBandwidth	Modify the internet bandwidth of an iPv6 address	Modifies the Internet bandwidth of an IPv6 address.
ModifyIpv6GatewayAttribute	Modify iPv6 gateway information	Modifies the information of an IPv6 gateway.
ModifyIpv6AddressAttribute	Modify the name and description of an iPv6 address	Modifies the name and description of an IPv6 address.
DescribeIpv6Gateways	Query created iPv6 gateways	Queries IPv6 gateways created in a specified region.
DescribeIpv6EgressOnlyRules	Query iPv6 egress-only rules	Queries IPv6 egress-only rules that you created.
DescribeIpv6Addresses	Query iPv6 addresses	Queries a list of IPv6 addresses.
DescribeIpv6GatewayAttribute	Query details of a specified iPv6 gateway	Queries the details of a specified IPv6 gateway, such as the region, VPC, running status, and billing method.
AllocateIpv6InternetBandwidth	Purchase internet bandwidth for an iPv6 address	Enables Internet bandwidth for an IPv6 address in a VPC so that the IPv6 address can communicate over the Internet. After Internet bandwidth is enabled, the IPv6 address can both initiate outbound connections to the Internet and be accessed from the Internet.

Region

API	Title	Description
DescribeRegions	Query available regions	Queries the available regions.
DescribeZones	Query zones in a specified region	Queries the list of zones in a specified region.

Tag

API	Title	Description
TagResources	Create and bind tags to specified resources	Creates and binds tags to specified resources.
TagResourcesForExpressConnect	Create and bind tags to express connect circuit instances	Creates and binds tags to specified Express Connect circuit instances.
UnTagResources	Unbind tags from a list of resources	Unbinds tags from a specified list of resources.
UntagResourcesForExpressConnect	Unbind tags from a specified list of express connect resources	Unbinds tags from a specified list of Express Connect resources.
ListTagResources	Query tags bound to cloud resources	Queries the tags that are bound to cloud resources.
DescribeTags	Query tags that meet filter conditions	Queries a list of tags that meet the specified filter conditions.
DescribeTagKeys	Query tag keys	Calls the DescribeTagKeys operation to return tag keys.
ListTagResourcesForExpressConnect	Query tags bound to express connect resources	Queries the tags that are bound to Express Connect resources by calling the ListTagResourcesForExpressConnect operation.
DescribeTagKeysForExpressConnect	Query express connect tag keys	Queries the tag list of Express Connect resources by calling the DescribeTagKeysForExpressConnect operation.

Router interface

API	Title	Description
CreateRouterInterface	Create a router interface	Creates a router interface.
DeleteRouterInterface	Delete a router interface	Deletes a router interface.
DeleteExpressConnect	Delete an express connect instance	Deletes an Express Connect instance, including the requester VPC and accepter VPC.
ModifyRouterInterfaceAttribute	Modify router interface configuration	Modifies the configuration of a router interface.
ModifyRouterInterfaceSpec	Modify the specification of a router interface	Modifies the specification of a router interface.
DescribeRouterInterfaces	Query router interfaces in a specified region	Queries router interfaces in a specified region.
DescribeEcGrantRelation	Query authorization relationships between VPC-connected instances and VBR instances in cross-account scenarios	Invokes the DescribeEcGrantRelation operation to query the authorization relationship of a VPC-connected instance to a VBR instance in a cross-account VBR uplink scenario.
DescribeRouterInterfaceAttribute	Query router interface configuration	Queries the configuration of a router interface.
DeactivateRouterInterface	Freeze a router interface	Freezes a router interface by calling the DeactivateRouterInterface operation.
GrantInstanceToVbr	Grant a VPC-connected instance to a VBR instance for cross-account VBR uplink scenarios	Invokes the GrantInstanceToVbr operation to grant authorization of a VPC-connected instance to a VBR instance for cross-account VBR uplink scenarios.
ActivateRouterInterface	Activate a router interface	Activates a router interface that is in the Inactive state.
RevokeInstanceFromVbr	Revoke VPC-connected instance-to-VBR authorization in a cross-account VBR uplink scenario	Invokes the RevokeInstanceFromVbr operation to revoke the authorization of a VPC-connected instance on a VBR instance in a cross-account VBR uplink scenario.
ConnectRouterInterface	Initiate a connection from the requester VPC router interface to the accepter	Calls the ConnectRouterInterface operation to initiate a connection from the requester VPC router interface to the accepter.

Gateway endpoint

API	Title	Description
CreateVpcGatewayEndpoint	Create a gateway endpoint	Creates a VPC gateway endpoint.
DeleteVpcGatewayEndpoint	Delete a gateway endpoint	Deletes a gateway endpoint.
UpdateVpcGatewayEndpointAttribute	Update gateway endpoint attribute	Calls the UpdateVpcGatewayEndpointAttribute operation to update the configuration of a VPC gateway endpoint.
ListVpcEndpointServicesByEndUser	Query available endpoint services	Queries the endpoint services that are available to you.
GetVpcGatewayEndpointAttribute	Get gateway endpoint attribute	Queries the attributes of a VPC gateway endpoint.
ListVpcGatewayEndpoints	Query VPC gateway endpoints	Queries a list of created VPC gateway endpoints.
AssociateRouteTablesWithVpcGatewayEndpoint	Associate route tables with a VPC gateway endpoint	Associates route tables with a VPC gateway endpoint by calling the AssociateRouteTablesWithVpcGatewayEndpoint operation.
DissociateRouteTablesFromVpcGatewayEndpoint	Disassociate a gateway endpoint from route tables	Disassociates a gateway endpoint from route tables by calling the DissociateRouteTablesFromVpcGatewayEndpoint operation.

Resource group

API	Title	Description
MoveResourceGroup	Modify the resource group of a cloud resource	Modifies the resource group to which a cloud resource belongs.
ChangeResourceGroup	Modify the resource group of an express connect circuit resource	Calls the ChangeResourceGroup operation to modify the resource group to which an Express Connect circuit resource belongs.