API概览

更新时间:
复制为 MD 格式

API标准及多语言预置SDK

本产品(Vpc/2016-04-28)的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(147535001692),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

自定义签名场景

若您的业务场景有特殊需求,需通过自签名方式对接 API,建议优先咨询我们的技术支持团队(服务钉钉群:147535001692),获取专业指导以确保高效接入。

账号与安全准备

阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露,所有相关资源都将面临未经授权访问的风险。为确保安全,建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey,同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下,才使用阿里云账号。

物理专线

API

标题

API概述

共享专线 共享专线
CreateVirtualPhysicalConnection 创建共享专线 调用CreateVirtualPhysicalConnection接口创建共享专线。
UpdateVirtualPhysicalConnection 修改共享专线信息 调用UpdateVirtualPhysicalConnection接口修改共享专线信息。
ListVirtualPhysicalConnections 查询共享专线的信息 调用ListVirtualPhysicalConnections接口查询共享专线的信息。
OpenPhysicalConnectionService 开通出云流量服务 调用OpenPhysicalConnectionService接口开通出方向流量服务。
CreatePhysicalConnection 申请物理专线接入 调用CreatePhysicalConnection接口申请物理专线接入。
ApplyPhysicalConnectionLOA 申请LOA 调用ApplyPhysicalConnectionLOA接口申请LOA。
SecondApplyPhysicalConnectionLOA 再次申请物理专线LOA 如果之前调用ApplyPhysicalConnectionLOA接口申请LOA被拒绝,可以调用本接口重新申请LOA。
CreatePhysicalConnectionSetupOrder 创建端口初装费订单 调用CreatePhysicalConnectionSetupOrder创建端口初装费订单。
CreatePhysicalConnectionOccupancyOrder 创建资源占用费订单 调用CreatePhysicalConnectionOccupancyOrder接口创建资源占用费用的订单。
CreateHighReliablePhysicalConnection 创建高可靠物理专线 创建高可靠模式物理专线,以满足您多线接入阿里云上业务的稳定性以及多线路容灾后可避免因为单线而导致的业务受损。
CreateVpconnFromVbr 转换共享专线推送方式 将共享专线从推送跨账号边界路由器VBR(Virtual Border Router)的方式转换为推送跨账号共享端口的方式。
DeletePhysicalConnection 删除物理专线 调用DeletePhysicalConnection接口删除物理专线连接。
CancelPhysicalConnection 取消物理专线接入 取消物理专线接入,取消后物理专线进入Canceled状态。
ModifyPhysicalConnectionAttribute 修改物理专线的配置 调用ModifyPhysicalConnectionAttribute接口修改物理专线的配置。
EnablePhysicalConnection 开通物理专线 开通处于Confirmed状态的物理专线,开通完成后物理专线进入Enabled状态。
TerminatePhysicalConnection 终止物理专线接入 在物理专线开通后,终止物理专线接入。
RecoverPhysicalConnection 恢复物理专线接入 调用RecoverPhysicalConnection接口恢复物理专线接入。
AttachVbrToVpconn 共享专线关联VBR 关联边界路由器VBR(Virtual Border Router)实例至共享专线。
GetPhysicalConnectionServiceStatus 获取物理连接服务状态 查看当前账号是否已开通出云流量费。
ConfirmPhysicalConnection 确认物理专线为可用状态 确认物理专线为可用状态,物理专线的状态会变为Confirmed。
DescribePhysicalConnections 查询指定地域内的物理专线 调用DescribePhysicalConnections接口查询指定地域内的物理专线信息。
ListPhysicalConnectionFeatures 查询物理专线的特性 查询物理专线支持的设备级能力
CompletePhysicalConnectionLOA 完成施工完竣 调用CompletePhysicalConnectionLOA完成施工完竣。
DescribePhysicalConnectionLOA 查询物理专线LOA信息 调用DescribePhysicalConnectionLOA查询物理专线LOA信息。
ListGeographicSubRegions 查询地域信息 调用ListGeographicSubRegions接口查询地域信息。
ListBusinessRegions 查询专线可购地域列表 查询专线可购地域列表
ListBusinessAccessPoints 查询物理专线的接入点信息 调用ListBusinessAccessPoints接口查询物理专线的接入点信息。

故障演练

API

标题

API概述

CreateFailoverTestJob 创建高速通道故障演练任务 调用CreateFailoverTestJob接口创建高速通道故障演练任务。
StartFailoverTestJob 开始高速通道故障演练任务 调用StartFailoverTestJob接口开始高速通道故障演练任务。
StopFailoverTestJob 结束高速通道故障演练任务 调用StopFailoverTestJob接口结束高速通道故障演练任务。
UpdateFailoverTestJob 更新高速通道故障演练任务 调用UpdateFailoverTestJob接口更新高速通道故障演练任务。
DeleteFailoverTestJob 删除高速通道故障演练任务 调用DeleteFailoverTestJob接口删除高速通道故障演练任务。
DescribeFailoverTestJob 查询高速通道故障演练任务详情 调用DescribeFailoverTestJob接口查询高速通道故障演练任务详情。
DescribeFailoverTestJobs 批量查询高速通道故障演练任务 调用DescribeFailoverTestJobs接口批量查询高速通道故障演练任务。

QoS策略

API

标题

API概述

DescribeExpressConnectTrafficQosRule 查询高速通道QoS规则 调用DescribeExpressConnectTrafficQosRule查询高速通道QoS规则,不支持分页参数。
DescribeExpressConnectTrafficQosQueue 查询高速通道QoS队列 调用DescribeExpressConnectTrafficQosQueue查询高速通道QoS队列。
DescribeExpressConnectTrafficQos 查询高速通道QoS策略 调用DescribeExpressConnectTrafficQos接口查询高速通道QoS策略,支持分页参数。
DeleteExpressConnectTrafficQosQueue 删除高速通道QoS队列 调用DeleteExpressConnectTrafficQosQueue接口删除高速通道QoS队列。
DeleteExpressConnectTrafficQos 删除高速通道QoS策略 调用DeleteExpressConnectTrafficQos接口删除高速通道QoS策略。
DeleteExpressConnectTrafficQosRule 删除高速通道QoS规则 调用DeleteExpressConnectTrafficQosRule接口删除高速通道QoS规则。
ModifyExpressConnectTrafficQos 修改高速通道QoS策略 调用ModifyExpressConnectTrafficQos接口修改高速通道QoS策略,也可通过本接口关联独享物理专线。
ModifyExpressConnectTrafficQosQueue 修改高速通道QoS队列 调用ModifyExpressConnectTrafficQosQueue接口修改高速通道QoS队列。
ModifyExpressConnectTrafficQosRule 修改高速通道QoS规则 调用ModifyExpressConnectTrafficQosRule接口修改高速通道QoS规则。
CreateExpressConnectTrafficQos 创建高速通道QoS策略 调用CreateExpressConnectTrafficQos接口创建高速通道QoS策略。
CreateExpressConnectTrafficQosQueue 创建高速通道QoS队列 调用CreateExpressConnectTrafficQosQueue接口创建高速通道QoS队列。
CreateExpressConnectTrafficQosRule 创建高速通道QoS规则 调用CreateExpressConnectTrafficQosRule接口创建高速通道QoS规则。

边界路由器

API

标题

API概述

VBR倒换组 VBR倒换组
CreateVbrHa 创建VBR倒换组 调用CreateVbrHa接口创建VBR倒换组。
DeleteVbrHa 删除VBR倒换组 调用DeleteVbrHa删除VBR倒换组。
DescribeVbrHa 查询VBR倒换组 调用DescribeVbrHa接口查询已创建的VBR倒换组。
AssociatePhysicalConnectionToVirtualBorderRouter VBR关联物理专线 调用AssociatePhysicalConnectionToVirtualBorderRouter接口将边界路由器VBR(Virtual Border Router)关联到物理专线。
CreateVirtualBorderRouter 新建边界路由器(VBR) 调用CreateVirtualBorderRouter接口创建边界路由器VBR(Virtual Border Router)实例。
DeleteVirtualBorderRouter 删除边界路由器(VBR) 调用DeleteVirtualBorderRouter接口删除VBR实例。
UnassociatePhysicalConnectionFromVirtualBorderRouter 解绑VBR和物理专线 调用UnassociatePhysicalConnectionFromVirtualBorderRouter解绑VBR和物理专线。
UpdateVirtualBorderBandwidth 修改VBR上下云的带宽限速 调用UpdateVirtualBorderBandwidth接口更新边界路由器上下云双方向的带宽限速。
ModifyVirtualBorderRouterAttribute 修改边界路由器(VBR)的配置 调用ModifyVirtualBorderRouterAttribute接口修改边界路由器VBR(Virtual Border Router)的配置。
TerminateVirtualBorderRouter 终止边界路由器(VBR) 调用TerminateVirtualBorderRouter接口终止边界路由器(VBR)。
RecoverVirtualBorderRouter 恢复被终止的边界路由器(VBR) 调用RecoverVirtualBorderRouter接口恢复被终止的VBR实例。
DescribeVirtualBorderRouters 查询已创建的边界路由器(VBR) 调用DescribeVirtualBorderRouters接口查询已创建的VBR实例。
DescribeGrantRulesToEcr 查询VBR的专线网关跨账号授权列表 查询VBR的专线网关跨账号授权列表。
DescribeVirtualBorderRoutersForPhysicalConnection 查询边界路由器(VBR) 查询指定物理专线下的边界路由器(VBR),包括物理专线所有者的VBR和其他账号的VBR。

BGP

API

标题

API概述

AddBgpNetwork 宣告BGP网络 调用AddBgpNetwork宣告BGP网络。
CreateBgpGroup 为指定的VBR创建一个BGP 为指定的边界路由器(VBR)创建一个BGP组。
CreateBgpPeer 向指定的BGP组中添加BGP邻居 调用CreateBgpPeer接口向指定的BGP组中添加BGP邻居。
DeleteBgpGroup 删除指定的BGP 使用DeleteBgpGroup删除指定的BGP组。
DeleteBgpNetwork 删除已宣告的BGP网络 使用DeleteBgpNetwork删除已宣告的BGP网络。
DeleteBgpPeer 删除指定的BGP邻居 调用DeleteBgpPeer删除指定的BGP邻居。
ModifyBgpGroupAttribute 修改BGP组的配置 调用ModifyBgpGroupAttribute接口修改BGP组的配置。
ModifyBgpPeerAttribute 修改BGP邻居的属性 调用ModifyBgpPeerAttribute接口修改BGP邻居的属性。
DescribeBgpGroups 查询指定地域下的BGP 查询指定地域下的BGP组。
DescribeBgpNetworks 查询已宣告的BGP网络 调用DescribeBgpNetworks查询已宣告的BGP网络。
DescribeBgpPeers 查询指定地域下的BGP邻居 调用DescribeBgpPeers接口查询指定地域下的BGP邻居。

标签

API

标题

API概述

TagResources 为指定的资源统一创建并绑定标签 为指定的资源统一创建并绑定标签。
TagResourcesForExpressConnect 为指定的高速通道专线实例统一创建并绑定标签 调用TagResourcesForExpressConnect接口为指定的高速通道专线实例统一创建并绑定标签。
UnTagResources 为资源列表统一解绑标签 为指定的资源列表统一解绑标签。
UntagResourcesForExpressConnect 为高速通道指定的资源列表统一解绑标签 调用UntagResourcesForExpressConnect接口为高速通道指定的资源列表统一解绑标签。
ListTagResources 查询云资源已经绑定的标签列表 查询云资源已经绑定的标签列表。
DescribeTags 查询满足筛选条件的标签列表 调用DescribeTags接口查询满足筛选条件的标签列表。
DescribeTagKeys 查询标签键 调用DescribeTagKeys接口返回标签键。
ListTagResourcesForExpressConnect 查询高速通道已经绑定的标签列表 调用ListTagResourcesForExpressConnect接口查询高速通道已经绑定的标签列表。
DescribeTagKeysForExpressConnect 查询高速通道的标签列表 调用DescribeTagKeysForExpressConnect接口返回高速通道的标签列表。

路由器接口

API

标题

API概述

CreateRouterInterface 创建路由器接口 调用CreateRouterInterface接口创建路由器接口。
DeleteRouterInterface 删除路由器接口 调用DeleteRouterInterface接口删除路由器接口。
DeleteExpressConnect 删除高速通道实例 删除高速通道实例,包含发起端和接收端。
ModifyRouterInterfaceAttribute 修改路由器接口的配置 调用ModifyRouterInterfaceAttribute接口修改路由器接口的配置。
ModifyRouterInterfaceSpec 修改路由器接口的规格 调用ModifyRouterInterfaceSpec接口修改路由器接口的规格。
DescribeRouterInterfaces 查询指定地域内的路由器接口 调用DescribeRouterInterfaces接口查询指定地域内的路由器接口。
DescribeEcGrantRelation 查询跨账号创建VBR上连场景下VPC实例对VBR实例的授权关系 调用DescribeEcGrantRelation接口查询跨账号创建VBR上连场景下VPC实例对VBR实例的授权关系。
DescribeRouterInterfaceAttribute 查看路由器接口配置 调用DescribeRouterInterfaceAttribute查看路由器接口配置。
DeactivateRouterInterface 冻结路由器接口 使用DeactivateRouterInterface冻结路由器接口。
GrantInstanceToVbr 将跨账号创建VBR上连场景的VPC实例授权给VBR实例 调用GrantInstanceToVbr接口将跨账号创建VBR上连场景的VPC实例授权给VBR实例。
ActivateRouterInterface 激活路由器接口 调用ActivateRouterInterface接口激活处于Inactive状态的路由器接口。
RevokeInstanceFromVbr 取消跨账号创建VBR上连场景下VPC实例对VBR实例的授权 调用RevokeInstanceFromVbr接口取消跨账号创建VBR上连场景下VPC实例对VBR实例的授权。
ConnectRouterInterface 由发起端路由器接口向接收端发起连接 调用ConnectRouterInterface接口由发起端路由器接口向接收端发起连接。

资源组

API

标题

API概述

MoveResourceGroup 修改云资源所属的资源组 修改云资源所属的资源组。
ChangeResourceGroup 修改物理专线资源所属的资源组 调用ChangeResourceGroup接口修改物理专线资源所属的资源组。

其他

API

标题

API概述

DescribeVpcGrantRulesToEcr 查询专线网关跨账号授权信息 查询指定网络实例的专线网关跨账号授权信息。
DeleteEnhancedVpnGateway 删除指定的增强型VPN网关 调用DeleteEnhancedVpnGateway接口删除指定的增强型VPN网关。
UpdateEnhancedVpnGateway 修改增强型VPN网关的名称、描述信息或路由自动传播功能 调用UpdateEnhancedVpnGateway接口修改增强型VPN网关的名称、描述信息或路由自动传播功能。
CreateEnhancedVpnGateway 创建增强型VPN网关 调用CreateEnhancedVpnGateway接口创建增强型VPN网关。
AssociateMacSecKey 关联MacSec密钥 支持在独享物理专线端口上面关联MacSec密钥,通过专用加密芯片(如 NIC 或交换机)实现低延迟加密/解密,从而直接对物理链路(如光纤、以太网)进行加密,覆盖从发送方到接收方的全部流量。
DisassociateMacSecKey 取消关联MacSec密钥 支持在独享物理专线端口上面取消关联MacSec密钥。