API标准及多语言预置SDK
本产品(专有网络/2016-04-28)的 OpenAPI 采用 RPC 签名机制,具体签名方式请参见签名机制说明。我们已为开发者封装了主流编程语言的 SDK,您可通过 下载 SDK 快速调用 API,无需关注签名等底层实现细节,显著降低开发门槛与集成复杂度。自定义签名场景
若您的业务场景有特殊需求,需通过自签名方式对接 API,建议优先咨询我们的技术支持团队(服务钉钉群:147535001692),获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露,所有相关资源都将面临未经授权访问的风险。为确保安全,建议创建一个仅具备 API 访问权限的 RAM 用户并配置其 AccessKey,同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下,才使用阿里云账号。
VPN网关
| API | 标题 | API概述 |
|---|---|---|
| CreateVpnGateway | 创建VPN网关 | 调用CreateVpnGateway接口创建VPN网关。 |
| DeleteVpnGateway | 删除指定的VPN网关 | 调用DeleteVpnGateway接口删除指定的VPN网关。 |
| ModifyVpnGatewayAttribute | 修改VPN网关的名称、描述信息或路由自动传播功能 | 调用ModifyVpnGatewayAttribute接口修改VPN网关的名称、描述信息或路由自动传播功能。 |
| MoveVpnResourceGroup | 修改VPN网关资源所属的资源组 | 修改VPN网关资源所属的资源组。 |
| DescribeVpnGateway | 查询指定VPN网关的详细信息 | 调用DescribeVpnGateway接口查询指定VPN网关的详细信息。 |
| DescribeVpnGateways | 查询已创建的VPN网关 | 调用DescribeVpnGateways接口查询指定地域下已创建的VPN网关。 |
| DiagnoseVpnGateway | 一键诊断指定的VPN网关实例 | 调用DiagnoseVpnGateway接口一键诊断指定的VPN网关实例。 |
| GetVpnGatewayDiagnoseResult | 查询VPN网关实例的一键诊断结果 | 调用GetVpnGatewayDiagnoseResult接口查询VPN网关实例的一键诊断结果。 |
| DescribeVpnGatewayAvailableZones | 查询指定地域支持部署IPsec连接的可用区列表 | 调用DescribeVpnGatewayAvailableZones接口查询指定地域支持部署IPsec连接的可用区列表。 |
用户网关
| API | 标题 | API概述 |
|---|---|---|
| CreateCustomerGateway | 创建用户网关 | 调用CreateCustomerGateway接口创建用户网关。 |
| DeleteCustomerGateway | 删除指定的用户网关 | 调用DeleteCustomerGateway接口删除指定的用户网关。 |
| ModifyCustomerGatewayAttribute | 修改用户网关的名称和描述信息 | 调用ModifyCustomerGatewayAttribute接口修改用户网关的配置。 |
| DescribeCustomerGateway | 查询已创建的用户网关 | 查询已创建的用户网关的详细信息。 |
| DescribeCustomerGateways | 查询已创建的用户网关列表 | 调用DescribeCustomerGateways接口查询用户网关的信息。 |
绑定VPN网关实例
| API | 标题 | API概述 |
|---|---|---|
| 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连接的日志信息。 |
| DiagnoseVpnConnections | 诊断IPsec连接 | 调用DiagnoseVpnConnections接口诊断IPsec连接。 |
| 目的路由 | 目的路由 | |
| CreateVpnRouteEntry | 创建目的路由 | 调用CreateVpnRouteEntry接口为VPN网关实例创建目的路由,创建目的路由后,VPN网关实例将基于流量的目的IP地址匹配目的路由,然后根据流量匹配到的目的路由转发流量。 |
| PublishVpnRouteEntry | 发布或者撤销VPN路由 | 调用PublishVpnRouteEntry接口将目的路由或策略路由发布到VPC的系统路由表中或将已发布的目的路由或策略路由从VPC系统路由表中撤销。 |
| DeleteVpnRouteEntry | 删除VPN目的路由 | 调用DeleteVpnRouteEntry接口删除VPN目的路由。 |
| ModifyVpnRouteEntryWeight | 修改目的路由的权重值 | 调用ModifyVpnRouteEntryWeight接口修改目的路由的权重值。 |
| DescribeVpnRouteEntries | 查询目的路由和BGP路由 | 调用DescribeVpnRouteEntries接口查询VPN网关实例的目的路由条目信息和BGP路由条目信息。 |
| 策略路由 | 策略路由 | |
| CreateVpnPbrRouteEntry | 创建VPN策略路由 | 调用CreateVpnPbrRouteEntry接口创建VPN策略路由。 |
| DeleteVpnPbrRouteEntry | 删除策略路由 | 调用DeleteVpnPbrRouteEntry接口删除策略路由。 |
| ModifyVpnPbrRouteEntryWeight | 修改VPN策略路由的权重值 | 调用ModifyVpnPbrRouteEntryWeight接口修改VPN策略路由的权重值。 |
| ModifyVpnPbrRouteEntryPriority | 修改策略路由的策略优先级 | 调用ModifyVpnPbrRouteEntryPriority接口修改策略路由的策略优先级。 |
| ModifyVpnPbrRouteEntryAttribute | 修改策略路由的权重值和策略优先级 | 调用ModifyVpnPbrRouteEntryAttribute接口修改策略路由的权重值和策略优先级。 |
| DescribeVpnPbrRouteEntries | 查询策略路由 | 调用DescribeVpnPbrRouteEntries接口查询VPN网关实例下配置的策略路由的信息。 |
绑定转发路由器实例
| API | 标题 | API概述 |
|---|---|---|
| CreateVpnAttachment | 创建IPsec连接 | 调用CreateVpnAttachment接口创建IPsec连接,用于绑定转发路由器实例。 |
| CreateVcoRouteEntry | 为IPsec连接添加目的路由条目 | 调用CreateVcoRouteEntry接口为IPsec连接添加目的路由条目。 |
| DeleteVpnAttachment | 删除IPsec连接 | 调用DeleteVpnAttachment接口删除IPsec连接。 |
| DeleteVcoRouteEntry | 删除IPsec连接下的目的路由条目 | 调用DeleteVcoRouteEntry接口删除IPsec连接下的目的路由条目。 |
| ModifyVpnAttachmentAttribute | 修改IPsec连接的配置 | 调用ModifyVpnAttachmentAttribute接口修改IPsec连接的配置。 |
| ModifyVcoRouteEntryWeight | 修改IPsec连接下目的路由条目的权重值 | 调用ModifyVcoRouteEntryWeight接口修改IPsec连接下目的路由条目的权重值。 |
| DescribeVpnAttachments | 查询已绑定转发路由器实例的IPsec连接的配置信息 | 调用DescribeVpnAttachments接口查询已绑定转发路由器实例的IPsec连接的配置信息。 |
| DescribeVcoRouteEntries | 查询IPsec连接下路由条目的信息 | 调用DescribeVcoRouteEntries接口查询IPsec连接下路由条目的信息。 |
| CheckVpnBgpEnabled | 查询IPsec连接所属的地域是否支持BGP功能 | 调用CheckVpnBgpEnabled接口查询IPsec连接所属的地域是否支持BGP功能。 |
| DescribeVpnCrossAccountAuthorizations | 查询IPsec连接的跨账号授权信息 | 调用DescribeVpnCrossAccountAuthorizations接口查询IPsec连接的跨账号授权信息。 |
标签
| API | 标题 | API概述 |
|---|---|---|
| TagResources | 为指定的资源统一创建并绑定标签 | 为指定的资源统一创建并绑定标签。 |
| UnTagResources | 为资源列表统一解绑标签 | 为指定的资源列表统一解绑标签。 |
| ListTagResources | 查询云资源已经绑定的标签列表 | 查询云资源已经绑定的标签列表。 |