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). |
| GrantInstanceToCen | GrantInstanceToCen | Grants permissions to a CEN instance. |
| AssociateVpcCidrBlock | Add a secondary CIDR block to a VPC | Adds a secondary CIDR block to a VPC. |
| AllocateVpcIpv6Cidr | AllocateVpcIpv6Cidr | Reserves an IPv6 CIDR block. |
| DeleteVpc | Delete a VPC | Calls the DeleteVpc operation to delete 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 | Query created VPCs | Queries created 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. |
vRouter
|
API |
Title |
Description |
| DescribeVRouters | Query vRouters in a specified region | Calls the DescribeVRouters operation to query the list of vRouters in a specified 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 | Create a default vSwitch | 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 | Delete a custom route entry | Calls the DeleteRouteEntry operation to delete a route from the 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 the ModifyRouteEntry operation to modify the name, description, and next hop of a custom route entry. |
| DescribeRouteTables | Query route tables | Calls the DescribeRouteTables operation to query route tables. |
| DescribeRouteEntryList | Query the list of route entries | Calls DescribeRouteEntryList to query the list of route entries. |
| ListVpcPublishedRouteEntries | Query VPC Route Publishing Status | Query the route publishing status |
| PublishVpcRouteEntries | Publish VPC Routes | Publish VPC Routes |
| ListGatewayRouteTableEntries | Query gateway route table entries | Queries the route entries in a gateway route table by calling the ListGatewayRouteTableEntries operation. |
Prefix list
|
API |
Title |
Description |
| ModifyVpcPrefixList | ModifyVpcPrefixList | Modifies the configuration of a prefix list. |
| GetVpcPrefixListAssociations | Query prefix list associations | Queries the associations of a prefix list by calling the GetVpcPrefixListAssociations operation. |
DHCP options set
|
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 | Creates a flow log. |
| ModifyFlowLogAttribute | ModifyFlowLogAttribute | Modifies the name and description of a flow log. |
| DescribeFlowLogs | Query Flow Logs | Query flow logs. |
Network ACL
|
API |
Title |
Description |
| UpdateNetworkAclEntries | UpdateNetworkAclEntries | Updates the rules of a network access control list (ACL). |
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-connected ECS instance | Invokes the AssociateHaVip operation to attach an HaVip to an ECS instance or a network interface controller (NIC) in a virtual private cloud (VPC). |
| DeleteHaVip | Delete a high-availability virtual IP address (HaVip) | 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 mirroring
|
API |
Title |
Description |
| Traffic mirror filter rule | Traffic mirror 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. |
| Traffic mirror filter | Traffic mirror filter | |
| CreateTrafficMirrorFilter | CreateTrafficMirrorFilter | Calls 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 | UpdateTrafficMirrorFilterAttribute | Modifies the configuration of a filter for traffic mirror. |
| ListTrafficMirrorFilters | ListTrafficMirrorFilters | Queries filters for traffic mirror. |
| 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 | 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 | 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 |
| 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 | Queries IPv6 gateways created in a specified region by calling the DescribeIpv6Gateways operation. |
Region
|
API |
Title |
Description |
| DescribeTags | Query tags that meet filter conditions | Queries a list of tags that meet the specified filter conditions. |
| DescribeTagKeys | DescribeTagKeys | Queries tag keys. |
Tag
|
API |
Title |
Description |
| DeleteExpressConnect | Delete an express connect instance | Deletes an Express Connect instance, including the requester VPC and accepter VPC. |
Router interface
|
API |
Title |
Description |
| ListVpcGatewayEndpoints | ListVpcGatewayEndpoints | Queries gateway endpoints. |