API概览

更新时间: 2023-09-22 13:44:10
本产品(专有网络/2016-04-28)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

VPN网关

API标题API概述
CreateVpnGateway创建VPN网关调用CreateVpnGateway接口创建VPN网关。
ModifyVpnGatewayAttribute修改VPN网关的名称和描述信息调用ModifyVpnGatewayAttribute接口修改VPN网关的名称和描述信息。
DescribeVpnGateway查询指定VPN网关的详细信息调用DescribeVpnGateway接口查询指定VPN网关的详细信息。
DescribeVpnGateways查询已创建的VPN网关调用DescribeVpnGateways接口查询指定地域下已创建的VPN网关。
AssociateVpnGatewayWithCertificate将VPN网关与证书关联调用AssociateVpnGatewayWithCertificate接口为VPN网关绑定证书。
DissociateVpnGatewayWithCertificate分离VPN网关与证书调用DissociateVpnGatewayWithCertificate接口解除VPN网关和证书的绑定关系。
ListVpnCertificateAssociations获取VPN证书关联列表调用ListVpnCertificateAssociations接口查询指定地域下VPN网关实例和证书的绑定关系。
DiagnoseVpnGateway一键诊断指定的VPN网关实例调用DiagnoseVpnGateway接口一键诊断指定的VPN网关实例。
GetVpnGatewayDiagnoseResult查询VPN网关实例的一键诊断结果调用GetVpnGatewayDiagnoseResult接口查询VPN网关实例的一键诊断结果。

用户网关

API标题API概述
CreateCustomerGateway创建用户网关调用CreateCustomerGateway接口创建用户网关。
DeleteCustomerGateway删除指定的用户网关调用DeleteCustomerGateway接口删除指定的用户网关。
ModifyCustomerGatewayAttribute修改用户网关的名称和描述信息调用ModifyCustomerGatewayAttribute接口修改用户网关的配置。
DescribeCustomerGateway查询已创建的用户网关查询已创建的用户网关的详细信息。
DescribeCustomerGateways查询已创建的用户网关列表调用DescribeCustomerGateways接口查询用户网关的信息。

SSL-VPN

API标题API概述
SSL客户端SSL客户端
CreateSslVpnClientCert创建SSL-VPN客户端证书调用CreateSslVpnClientCert接口创建SSL-VPN客户端证书。
DeleteSslVpnClientCert删除SSL-VPN客户端证书调用DeleteSslVpnClientCert接口删除SSL-VPN客户端证书。
ModifySslVpnClientCert修改SSL-VPN客户端证书的名称调用ModifySslVpnClientCert接口修改SSL-VPN客户端证书的名称。
DescribeSslVpnClientCerts查询已创建的SSL-VPN客户端证书调用DescribeSslVpnClientCerts接口查询已创建的SSL客户端证书。
DescribeSslVpnClientCert查询指定的SSL客户端证书信息调用DescribeSslVpnClientCert接口查询指定的SSL客户端证书信息。
DescribeSslVpnClients查询SSL-VPN连接的客户端的信息调用DescribeSslVpnClients接口查询指定VPN网关实例下已与阿里云建立SSL-VPN连接的客户端的信息。
SSL服务端SSL服务端
CreateSslVpnServer创建SSL-VPN服务端调用CreateSslVpnServer接口创建SSL-VPN服务端。
DeleteSslVpnServer删除SSL-VPN服务端实例调用DeleteSslVpnServer接口删除SSL-VPN服务端实例。
ModifySslVpnServer修改SSL-VPN服务端的配置信息调用ModifySslVpnServer接口修改SSL-VPN服务端的配置信息。
DescribeSslVpnServers查询已创建的SSL-VPN服务端调用DescribeSslVpnServers接口查询已创建的SSL-VPN服务端。
DescribeVpnSslServerLogs查看SSL服务端的日志调用DescribeVpnSslServerLogs接口查看SSL服务端的日志。

IPsec-VPN

API标题API概述
绑定转发路由器实例绑定转发路由器实例
CreateVpnAttachment创建IPsec连接调用CreateVpnAttachment接口创建IPsec连接,用于绑定转发路由器实例。
ModifyVpnAttachmentAttribute修改IPsec连接的配置调用ModifyVpnAttachmentAttribute接口修改IPsec连接的配置。
DeleteVpnAttachment删除IPsec连接调用DeleteVpnAttachment接口删除IPsec连接。
DescribeVpnAttachments查询已绑定转发路由器实例的IPsec连接的配置信息调用DescribeVpnAttachments接口查询已绑定转发路由器实例的IPsec连接的配置信息。
CreateVcoRouteEntry为IPsec连接添加目的路由条目调用CreateVcoRouteEntry接口为IPsec连接添加目的路由条目。
DeleteVcoRouteEntry删除IPsec连接下的目的路由条目调用DeleteVcoRouteEntry接口删除IPsec连接下的目的路由条目。
ModifyVcoRouteEntryWeight修改IPsec连接下目的路由条目的权重值调用ModifyVcoRouteEntryWeight接口修改IPsec连接下目的路由条目的权重值。
DescribeVcoRouteEntries查询IPsec连接下路由条目的信息调用DescribeVcoRouteEntries接口查询IPsec连接下路由条目的信息。
CheckVpnBgpEnabled查询IPsec连接所属的地域是否支持BGP功能调用CheckVpnBgpEnabled接口查询IPsec连接所属的地域是否支持BGP功能。
DescribeVpnCrossAccountAuthorizations查询IPsec连接的跨账号授权信息调用DescribeVpnCrossAccountAuthorizations接口查询IPsec连接的跨账号授权信息。
绑定VPN网关实例绑定VPN网关实例
CreateVpnConnection创建IPsec连接调用CreateVpnConnection接口创建IPsec连接。
DeleteVpnConnection删除指定的IPsec连接调用DeleteVpnConnection接口删除指定的IPsec连接。
ModifyVpnConnectionAttribute修改IPsec连接的配置信息调用ModifyVpnConnectionAttribute接口修改IPsec连接的配置信息。
ModifyTunnelAttribute修改VPN隧道信息调用ModifyTunnelAttribute接口修改高可用VPN的隧道配置信息。
DescribeVpnConnection查询已创建的IPsec连接的详细信息调用DescribeVpnConnection接口查询指定的IPsec连接的信息。
DescribeVpnConnections查询已创建的IPsec连接调用DescribeVpnConnections接口查询IPsec连接信息。
DownloadVpnConnectionConfig获取IPsec连接的配置信息调用DownloadVpnConnectionConfig接口获取IPsec连接的配置信息。
DescribeVpnConnectionLogs查询IPsec连接的日志调用DescribeVpnConnections接口查询IPsec连接的日志信息。

策略路由

API标题API概述
CreateVpnPbrRouteEntry创建VPN策略路由调用CreateVpnPbrRouteEntry接口创建VPN策略路由。
DeleteVpnPbrRouteEntry删除VPN策略路由调用DeleteVpnPbrRouteEntry接口删除VPN策略路由。
ModifyVpnPbrRouteEntryWeight修改VPN策略路由的权重值调用ModifyVpnPbrRouteEntryWeight接口修改VPN策略路由的权重值。
ModifyVpnPbrRouteEntryPriority修改策略路由的策略优先级调用ModifyVpnPbrRouteEntryPriority接口修改策略路由的策略优先级。
ModifyVpnPbrRouteEntryAttribute修改策略路由的权重值和策略优先级调用ModifyVpnPbrRouteEntryAttribute接口修改策略路由的权重值和策略优先级。
DescribeVpnPbrRouteEntries查询策略路由调用DescribeVpnPbrRouteEntries接口查询VPN网关实例下配置的策略路由的信息。

目的路由

API标题API概述
CreateVpnRouteEntry创建VPN目的路由调用CreateVpnRouteEntry接口为VPN网关实例创建目的路由。
PublishVpnRouteEntry发布VPN路由到VPC调用PublishVpnRouteEntry接口发布VPN路由到VPC。
DeleteVpnRouteEntry删除VPN目的路由调用DeleteVpnRouteEntry接口删除VPN目的路由。
ModifyVpnRouteEntryWeight修改VPN目的路由的权重值调用ModifyVpnRouteEntryWeight接口修改VPN目的路由的权重值。
DescribeVpnRouteEntries查询目的路由和BGP路由调用DescribeVpnRouteEntries接口查询VPN网关实例的目的路由条目信息和BGP路由条目信息。

IPsec服务端

API标题API概述
CreateIpsecServer创建IPsec服务端调用CreateIpsecServer接口创建IPsec服务端。
UpdateIpsecServer更新IPsec服务端调用UpdateIpsecServer接口更新IPsec服务端配置。
ListIpsecServers获取IPsec服务端列表调用ListIpsecServers接口查看已创建的IPsec服务端。
ListIpsecServerLogs查看IPsec服务端日志调用ListIpsecServerLogs接口查看IPsec服务端日志。
DeleteIpsecServer删除IPsec服务端调用DeleteIpsecServer接口删除IPsec服务端。

标签

API标题API概述
TagResources为指定的资源统一创建并绑定标签为指定的资源统一创建并绑定标签。
ListTagResources查询云资源已经绑定的标签列表查询云资源已经绑定的标签列表。
UnTagResources为资源列表统一解绑标签为指定的资源列表统一解绑标签。
阿里云首页 VPN网关 相关技术圈