API Overview

Last updated: 2019-12-02 14:12:00

    1. VPC APIs

    API function Action ID Description
    Create a VPC CreateVpc Create a VPC and configure its IP range.
    Delete a VPC DeleteVpc Delete a VPC.
    Change the VPC name ModifyVpcAttribute Change the name of the specified VPC.
    Query the VPC list DescribeVpcEx Batch query VPC information, supports paging query and fuzzy matching.
    Bind a VPC CVM to a VIP AssociateVip Bind a VIP to a VPC CVM.
    Establish a connection between the VPC and basic network devices AttachClassicLinkVpc Create a connection between the VPC and basic network devices.
    Delete the connection between the VPC and basic network devices DetachClassicLinkVpc Delete the connection between the VPC and basic network devices.
    Query the connections between the VPC and basic network devices DescribeVpcClassicLink Query the connections between the VPC and basic network devices.

    2. Subnet APIs

    API function Action ID Description
    Create a subnet CreateSubnet Create a subnet and specify its availability zone.
    Delete a subnet DeleteSubnet Delete the specified subnet.
    Change the subnet name ModifySubnetAttribute Change the name of the specified subnet.
    Query the subnet list DescribeSubnetEx Batch query subnet information, supports paging query and fuzzy matching.
    Query subnet details DescribeSubnet Query the details of a subnet based on the input information, such as subnetId and the subnet name.

    3. Routing Table APIs

    API function Action ID Description
    Create a routing table CreateRouteTable Create a routing table.
    Delete the routing table DeleteRouteTable Delete the specified routing table, after which all the routing policies in the routing table become invalid.
    Modify the routing table ModifyRouteTableAttribute Change the name of the specified routing table.
    Query a routing table DescribeRouteTable Query the details of a routing table based on the input information, such as routeTableId and the routing table name.
    Modify the routing table associated with a subnet AssociateRouteTable Modify the routing table associated with a subnet.
    Create a routing policy CreateRoute Create a routing policy.
    Delete a routing policy DeleteRoute Delete a routing policy.

    4. Network ACL APIs

    API function Action ID Description
    Create a VPC network ACL CreateNetworkAcl Create a security firewall.
    Delete a network ACL DeleteNetworkAcl Delete the specified security firewall.
    Change a network ACL name ModifyNetworkAcl Change the name of a security firewall.
    Query the network ACL list DescribeNetworkAcl Query the VPC security firewall list.
    Set network ACL rules ModifyNetworkAclEntry Set security firewall ACL rules.
    Bind a network ACL to a subnet CreateSubnetAclRule Bind a security firewall with a subnet.
    Unbind a network ACL from a subnet DeteleSubnetAclRule Unbind a security firewall from a subnet.

    5. VPN APIs

    API function Action ID Description
    Query the price of a VPN gateway InquiryVpnPrice Query the price of a VPN gateway.
    Purchase a VPN gateway CreateVpn Purchase a VPN gateway.
    Modify VPN gateway attributes ModifyVpnGw Modify the information of the specified VPN gateway, such as the name.
    Query the VPN gateway list DescribeVpnGw Query the information of a VPN gateway based on the iinput information, such as the ID and name of the VPN gateway.
    Renew a VPN gateway RenewVpn Renew a VPN gateway.

    6. User Gateway APIs

    API function Action ID Description
    Create a user gateway AddUserGw Create a user gateway to be connected to.
    Delete a user gateway DeleteUserGw Delete a user gateway.
    Change the name of a user gateway ModifyUserGw Change the name of a user gateway.
    Query the user gateway list DescribeUserGw Query the information of a user gateway based on input information, such as the ID and name of the user gateway.
    Obtain information about supported user gateway vendors DescribeUserGwVendor Query the information about user gateway vendors supported by Tencent Cloud VPN gateways.

    7. VPN Tunnel APIs

    API function Action ID Description
    Create a VPN tunnel AddVpnConnEx Create an encrypted VPN tunnel to connect a VPC to other network resources.
    Delete a VPN tunnel DeleteVpnConn Delete the specified VPN tunnel.
    Modify a VPN tunnel ModifyVpnConnEx Modify the information of the specified VPN tunnel, such as the name.
    Query the VPN tunnel list DescribeVpnConn Query the information of a tunnel based on input information, such as the ID and name of the VPN tunnel.
    Download VPN tunnel configuration GetVpnConnConfig Download the configuration of a VPN tunnel to modify it.
    Obtain the monitoring data of a VPN tunnel DescribeVpnConnMonitor Obtain the monitoring data of a VPN tunnel.

    8. SSL VPN APIs

    API function Action ID Description
    Query sslVPN DescribeSSLVpn Query sslVPN.
    Query the sslVPN domain DescribeSSLVpnDomain Query the sslVPN domain.
    Set sslVPN domain SetSSLVpnDomain Set the sslVPN domain.

    9. Peering Connection APIs

    API function Action ID Description
    Establish an intra-region peering connection CreateVpcPeeringConnection Create an intra-region peering connection.
    Delete an intra-region peering connection DeleteVpcPeeringConnection Delete an intra-region peering connection.
    Modify an intra-region peering connection ModifyVpcPeeringConnection Modify an intra-region peering connection.
    Accept an intra-region peering connection AcceptVpcPeeringConnection Accept an intra-region peering connection.
    Reject an intra-region peering connection RejectVpcPeeringConnection Reject an intra-region peering connection.
    Enable an expired intra-region peering connection EnableVpcPeeringConnection Enable an expired intra-region peering connection.
    Create a cross-region peering connection CreateVpcPeeringConnectionEx Create a cross-region peering connection.
    Delete a cross-region peering connection DeleteVpcPeeringConnectionEx Delete a cross-region peering connection.
    Modify the attributes of a cross-region peering connection ModifyVpcPeeringConnectionEx Modify the attributes of a cross-region peering connection.
    Accept a cross-region peering connection AcceptVpcPeeringConnectionEx Accept a cross-region peering connection.
    Reject a cross-region peering connection RejectVpcPeeringConnectionEx Reject a cross-region peering connection.
    Enable an expired cross-region peering connection EnableVpcPeeringConnectionEx Enable an expired cross-region peering connection.
    Query a peering connection DescribeVpcPeeringConnections Query a peering connection.

    10. Direct Connect Gateway APIs

    API function Action ID Description
    Create a direct connect gateway CreateDirectConnectGateway Create a direct connect gateway.
    Modify the attributes of a direct connect gateway ModifyDirectConnectGateway Modify the attributes of a direct connect gateway.
    Delete a direct connect gateway DeleteDirectConnectGateway Delete a direct connect gateway.
    Query a direct connect gateway DescribeDirectConnectGateway Query a direct connect gateway.
    Create a local IP translation rule for a direct connect gateway CreateLocalIPTranslationNatRule Create a local IP translation rule for a direct connect gateway.
    Delete the local IP translation rule for a direct connect gateway DeleteLocalIPTranslationNatRule Delete the local IP translation rule for a direct connect gateway.
    Modify the local IP translation rule for a direct connect gateway ModifyLocalIPTranslationNatRule Modify the local IP translation rule for a direct connect gateway.
    Query the local IP translation rule for a direct connect gateway DescribeLocalIPTranslationNatRule Query the local IP translation rule for a direct connect gateway.
    Create a local source IP port translation rule for a direct connect gateway CreateLocalSourceIPPortTranslationNatRule Create a local source IP port translation rule for a direct connect gateway.
    Delete the local source IP port translation rule for a direct connect gateway DeleteLocalSourceIPPortTranslationNatRule Delete the local source IP port translation rule for a direct connect gateway.
    Modify the local source IP port translation rule for a direct connect gateway ModifyLocalSourceIPPortTranslationNatRule Modify the local source IP port translation rule for a direct connect gateway.
    Query the local source IP port translation rule for a direct connect gateway DescribeLocalSourceIPPortTranslationNatRule Query the local source IP port translation rule for a direct connect gateway.
    Create a local destination IP port translation rule for a direct connect gateway CreateLocalDestinationIPPortTranslationNatRule Create a local destination IP port translation rule for a direct connect gateway.
    Delete the local destination IP port translation rule for a direct connect gateway DeleteLocalDestinationIPPortTranslationNatRule Delete the local destination IP port translation rule for a direct connect gateway.
    Modify the local destination IP port translation rule for a direct connect gateway ModifyLocalDestinationIPPortTranslationNatRule Modify the local destination IP port translation rule for a direct connect gateway.
    Query the local destination IP port translation rule for a direct connect gateway DescribeLocalDestinationIPPortTranslationNatRule Query the local destination IP port translation rule for a direct connect gateway.
    Create a peer IP translation rule for a direct connect gateway CreatePeerIPTranslationNatRule Create a peer IP translation rule for a direct connect gateway.
    Delete the peer source IP translation rule for a direct connect gateway DeletePeerIPTranslationNatRule Delete the peer source IP translation rule for a direct connect gateway.
    Modify the peer IP translation rule for a direct connect gateway ModifyPeerIPTranslationNatRule Modify the peer IP translation rule for a direct connect gateway.
    Query the peer IP translation rule for a direct connect gateway DescribePeerIPTranslationNatRule Query the peer IP port translation rule for a direct connect gateway.
    Create a local IP translation ACL policy CreateLocalIPTranslationAclRule Create a local IP translation ACL policy.
    Delete a local IP translation ACL policy DeleteLocalIPTranslationAclRule Delete a local IP translation ACL policy.
    Modify a local IP translation ACL policy ModifyLocalIPTranslationAclRule Modify a local IP translation ACL policy.
    Query a local IP translation ACL policy DescribeLocalIPTranslationAclRule Query a local IP translation ACL policy.
    Create a local IP port translation ACL policy CreateLocalSourceIPPortTranslationAclRule Create a local IP port translation ACL policy.
    Delete a local IP port translation ACL policy DeleteLocalSourceIPPortTranslationAclRule Delete a local IP port translation ACL policy.
    Modify a local IP port translation ACL policy ModifyLocalSourceIPPortTranslationAclRule Modify a local IP port translation ACL policy.
    Query a local IP port translation ACL policy DescribeLocalSourceIPPortTranslationAclRule Query a local IP port translation ACL policy.

    11. NAT Gateway APIs

    API function Action ID Description
    Create a NAT Gateway CreateNatGateway Create a NAT gateway.
    Query the NAT gateway creation progress QueryNatGatewayProductionStatus Query the creation progress of a NAT gateway.
    Delete a NAT gateway DeleteNatGateway Delete a NAT gateway.
    Modify a NAT gateway ModifyNatGateway Modify a NAT gateway.
    Query a NAT gateway DescribeNatGateway Query a NAT gateway.
    Bind an EIP to a NAT gateway EipBindNatGateway Bind an EIP to a NAT gateway.
    Unbind an EIP from a NAT gateway EipUnBindNatGateway Unbind an EIP from a NAT gateway.
    Upgrade NAT gateway specification UpgradeNatGateway Upgrade the specification of a NAT gateway.

    12. ENI APIs

    API function Action ID Description
    Create an ENI CreateNetworkInterface Create an ENI.
    Delete an ENI DeleteNetworkInterface Delete an ENI.
    Query ENI Information DescribeNetworkInterfaces Query the information of an ENI.
    Assign a private IP address for an ENI AssignPrivateIpAddresses Assign a private IP address for an ENI.
    Unassign a private IP address from an ENI UnassignPrivateIpAddresses Unassign a private IP address from an ENI.
    Bind an ENI to a CVM AttachNetworkInterface Bind an ENI to a CVM.
    Unbind an ENI from a CVM DetachNetworkInterface Unbind an ENI from a CVM.
    Migrate an ENI MigrateNetworkInterface Migrate an ENI.
    Migrate a private IP address MigratePrivateIpAddress Migrate a private IP address.

    13. Flow Log APIs

    API function Action ID Description
    Create a flow log CreateFlowLog Create a flow log.
    Delete a flow log DeleteFlowLog Delete a flow log.
    Query flow log information DescribeFlowLog Query the information of a flow log.
    Query the flow log list DescribeFlowLogs Query the information of the flow log list.
    Modify flow log attributes ModifyFlowLogAttribute Modify the attributes of a flow log.

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help