API概览

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

云企业网实例

API标题API概述
CreateCen创建云企业网实例创建云企业网实例。
DeleteCen删除指定的云企业网实例删除云企业网实例。
ModifyCenAttribute编辑云企业网实例的名称和描述信息修改云企业网实例的名称和描述信息。
DescribeCens查看账户下所有云企业网实例的详细信息查询当前阿里云账号下的云企业网实例信息。
DescribeGrantRulesToResource查询网络实例对跨账号云企业网实例的授权信息查询网络实例对跨账号云企业网实例的授权信息。
MoveResourceGroup修改云企业网实例或带宽包实例所属的资源组修改云企业网实例或带宽包实例所属的资源组。

转发路由器实例

API标题API概述
CreateTransitRouter创建企业版转发路由器实例创建企业版转发路由器实例。
DeleteTransitRouter删除企业版转发路由器实例删除企业版转发路由器实例。
UpdateTransitRouter修改转发路由器实例信息修改转发路由器实例的名称和描述信息。
ListTransitRouters查询云企业网实例下转发路由器实例的信息查询云企业网实例下转发路由器实例的信息。
ListTransitRouterAvailableResource查询指定地域下企业版转发路由器支持的可用区信息查询指定地域下企业版转发路由器支持的可用区信息。
OpenTransitRouterService开通转发路由器服务开通转发路由器服务。
CheckTransitRouterService查询当前阿里云账号是否已开通转发路由器服务查询当前阿里云账号是否已开通转发路由器服务。
GrantInstanceToTransitRouter为转发路由器实例授予连接跨账号网络实例的权限为转发路由器实例授予连接跨账号网络实例的权限。
RevokeInstanceFromTransitRouter取消转发路由器实例连接跨账号网络实例的权限取消转发路由器实例连接跨账号网络实例的权限。

转发路由地址段

API标题API概述
CreateTransitRouterCidr创建转发路由器下CIDR地址段创建转发路由器下CIDR地址段。
DeleteTransitRouterCidr删除转发路由器下CIDR地址段删除转发路由器下CIDR地址段。
ModifyTransitRouterCidr修改转发路由器下的CIDR地址段修改转发路由器下的CIDR地址段。
ListTransitRouterCidr查询转发路由器下CIDR地址段查询转发路由器下CIDR地址段。
ListTransitRouterCidrAllocation查询CIDR地址段的分配信息查询CIDR地址段的分配信息。

网络实例连接

API标题API概述
专有网络连接专有网络连接
CreateTransitRouterVpcAttachment在企业版转发路由器下创建专有网络VPC连接在企业版转发路由器下创建专有网络VPC(Virtual Private Cloud)连接。
DeleteTransitRouterVpcAttachment删除企业版转发路由器下的专有网络VPC连接删除企业版转发路由器下的专有网络VPC(Virtual Private Cloud)连接。
UpdateTransitRouterVpcAttachmentAttribute修改转发路由器下VPC附件属性修改企业版转发路由器下VPC连接的名称和描述信息。
UpdateTransitRouterVpcAttachmentZones修改专有网络VPC连接关联的可用区和交换机修改专有网络VPC(Virtual Private Cloud)连接关联的可用区和交换机。
ListTransitRouterVpcAttachments查询企业版转发路由器下专有网络VPC连接的信息查询企业版转发路由器下专有网络VPC(Virtual Private Cloud)连接的信息。
边界路由器连接边界路由器连接
CreateTransitRouterVbrAttachment在企业版转发路由器下创建边界路由器VBR连接在企业版转发路由器下创建边界路由器VBR(Virtual border router)连接。
DeleteTransitRouterVbrAttachment删除企业版转发路由器下的边界路由器VBR连接删除企业版转发路由器下的边界路由器VBR(Virtual border router)连接。
UpdateTransitRouterVbrAttachmentAttribute修改转发路由器下VBR附件属性修改企业版转发路由器下VBR连接的名称和描述信息。
ListTransitRouterVbrAttachments查询企业版转发路由器下的边界路由器VBR连接信息查询企业版转发路由器下的边界路由器VBR(Virtual border router)连接信息。
VPN连接VPN连接
CreateTransitRouterVpnAttachment创建VPN连接创建VPN连接。
DeleteTransitRouterVpnAttachment删除VPN连接删除VPN连接。
UpdateTransitRouterVpnAttachmentAttribute修改VPN连接的配置修改VPN连接的配置。
ListTransitRouterVpnAttachments查询VPN连接的信息调用ListTransitRouterVpnAttachment接口查询VPN连接的信息。
AttachCenChildInstance将网络实例加载到云企业网实例中将网络实例加载到云企业网实例中。
DetachCenChildInstance从云企业网实例中解绑指定的网络实例调用DetachCenChildInstance接口卸载云企业网实例中的网络实例。
DescribeCenAttachedChildInstanceAttribute查看网络实例(VPC、VBR、CCN)详细信息查看加载到CEN中的网络实例(VPC、VBR、CCN)的详细信息。
DescribeCenAttachedChildInstances查询云企业网实例下已加载的网络实例信息查询云企业网实例下已加载的网络实例信息。
DescribeChildInstanceRegions查询云企业网支持加载网络实例的地域信息查询云企业网支持加载网络实例的地域信息。
DescribeGrantRulesToCen查看网络实例对云企业网实例的授权关系查询云企业网实例已获得授权的跨账号的网络实例的信息。
ListGrantVSwitchesToCen查询云企业网实例已连接的跨账号专有网络VPC下交换机的信息调用ListGrantVSwitchesToCen接口查询云企业网实例已连接的跨账号专有网络VPC(Virtual Private Cloud)下交换机的信息。

带宽包

API标题API概述
CreateCenBandwidthPackage创建带宽包创建带宽包实例。
DeleteCenBandwidthPackage删除带宽包删除带宽包实例。
ModifyCenBandwidthPackageAttribute修改带宽包实例的名称和描述信息修改带宽包实例的名称和描述信息。
ModifyCenBandwidthPackageSpec修改带宽包实例的带宽峰值修改带宽包实例的带宽峰值。
DescribeCenGeographicSpanRemainingBandwidth查询指定带宽包的剩余可用带宽值查询指定带宽包实例的剩余带宽值。
DescribeCenBandwidthPackages查询账户下所有带宽包的详细信息查询带宽包实例的信息。
DescribeCenGeographicSpans查询云企业网支持的互通区域的信息查询云企业网支持的互通区域的信息。
DescribeGeographicRegionMembership查看指定区域内所有的地域查询指定区域内的地域信息。
TempUpgradeCenBandwidthPackageSpec进行云企业网预付费带宽包临时升配对云企业网预付费带宽包实例临时升配。
UnassociateCenBandwidthPackage解绑带宽包与云企业网实例将带宽包与云企业网实例之间的绑定取消。取消绑定后,该带宽包可以绑定至其他云企业网实例。
AssociateCenBandwidthPackage将带宽包绑定到指定的云企业网实例将带宽包实例绑定至云企业网实例。

跨地域连接

API标题API概述
CreateTransitRouterPeerAttachment为企业版转发路由器实例创建跨地域连接为企业版转发路由器实例创建跨地域连接。
DeleteTransitRouterPeerAttachment删除企业版转发路由器下的跨地域连接删除企业版转发路由器下的跨地域连接。
SetCenInterRegionBandwidthLimit设置带宽包中两个地域间的跨地域互通带宽设置、修改或删除两个地域间的跨地域互通带宽。
UpdateTransitRouterPeerAttachmentAttribute修改企业版转发路由器下跨地域连接的配置修改企业版转发路由器下跨地域连接的配置。
ListTransitRouterPeerAttachments查询企业版转发路由器下的跨地域连接信息查询企业版转发路由器下的跨地域连接信息。
DescribeCenInterRegionBandwidthLimits查询各个地域之间的跨地域互通带宽查询各个地域之间的跨地域互通带宽。

管理路由

API标题API概述
CreateCenChildInstanceRouteEntryToAttachment为企业版转发路由器连接的网络实例添加路由条目为企业版转发路由器连接的网络实例添加路由条目。
CreateCenChildInstanceRouteEntryToCen为网络实例添加路由条目为网络实例添加路由条目。
DeleteCenChildInstanceRouteEntryToAttachment删除企业版转发路由器连接的网络实例的路由条目删除企业版转发路由器连接的网络实例的路由条目。
DeleteCenChildInstanceRouteEntryToCen删除网络实例下的路由条目调用DeleteCenChildInstanceRouteEntryToCen接口删除网络实例下的路由条目。
ListCenChildInstanceRouteEntriesToAttachment查询企业版转发路由器连接的网络实例的路由条目查询企业版转发路由器下网络实例路由表中指向网络实例连接的路由条目。
DescribeCenRegionDomainRouteEntries查询实例路由条目详细信息查询云企业网实例中某个地域内路由条目的详细信息。
DescribeCenChildInstanceRouteEntries查询云企业网的网络实例路由条目查询云企业网中网络实例的路由条目信息。
DescribePublishedRouteEntries查询路由在CEN中的发布情况查询已加载到CEN网络实例(VPC和VBR)的各条路由在CEN中的发布情况。
DescribeRouteConflict查询网络实例中存在冲突的路由条目信息查询网络实例中存在冲突的路由条目信息。
PublishRouteEntries将路由条目发布到CEN将加载到CEN中的VPC或VBR的路由条目发布到CEN中。
WithdrawPublishedRouteEntries撤回已发布至云企业网的路由条目撤回专有网络VPC(Virtual Private Cloud)或边界路由器VBR(Virtual border router)实例已发布至云企业网的路由条目。

转发路由器路由表

API标题API概述
CreateTransitRouterRouteTable为企业版转发路由器创建自定义路由表为企业版转发路由器创建自定义路由表。
DeleteTransitRouterRouteTable删除企业版转发路由器的自定义路由表删除企业版转发路由器的自定义路由表。
UpdateTransitRouterRouteTable修改企业版转发路由器路由表的名称和描述信息修改企业版转发路由器路由表的名称和描述信息。
ListTransitRouterRouteTables查询企业版转发路由器的路由表信息查询企业版转发路由器的路由表信息。

转发路由器路由条目

API标题API概述
CreateTransitRouterRouteEntry在企业版转发路由器的路由表中添加路由条目在企业版转发路由器的路由表中添加路由条目。
DeleteTransitRouterRouteEntry删除企业版转发路由器路由表中静态配置的路由条目删除企业版转发路由器路由表中静态配置的路由条目。
UpdateTransitRouterRouteEntry修改企业版转发路由器路由表中路由条目的名称和描述信息修改企业版转发路由器路由表中路由条目的名称和描述信息。
ListTransitRouterRouteEntries查询企业版转发路由器路由表中的路由条目信息查询企业版转发路由器路由表中的路由条目信息。

关联转发关系

API标题API概述
ListTransitRouterRouteTableAssociations查询企业版转发路由器路由表或网络实例连接已创建的关联转发关系查询企业版转发路由器路由表或网络实例连接已创建的关联转发关系。
AssociateTransitRouterAttachmentWithRouteTable创建关联转发关系创建关联转发关系。
ReplaceTransitRouterRouteTableAssociation更换网络实例连接关联的转发路由器路由表更换网络实例连接关联的转发路由器路由表。
DissociateTransitRouterAttachmentFromRouteTable解除关联转发关系解除关联转发关系。

路由学习关系

API标题API概述
EnableTransitRouterRouteTablePropagation创建路由学习关系创建路由学习关系。
DisableTransitRouterRouteTablePropagation解除路由学习关系解除路由学习关系。
ListTransitRouterRouteTablePropagations查询企业版转发路由器路由表的路由学习关系查询企业版转发路由器路由表的路由学习关系。

路由策略

API标题API概述
CreateCenRouteMap创建路由策略创建路由策略。
DeleteCenRouteMap删除路由策略删除路由策略。
ModifyCenRouteMap修改路由策略修改路由策略。
DescribeCenRouteMaps查询路由策略查询路由策略信息。

聚合路由

API标题API概述
CreateTransitRouteTableAggregation创建聚合路由创建聚合路由。
DeleteTransitRouteTableAggregation删除聚合路由删除聚合路由。
RefreshTransitRouteTableAggregation重新发布聚合路由重新发布聚合路由。
DescribeTransitRouteTableAggregationDetail查询指定聚合路由的配置详情查询指定聚合路由的配置详情。
DescribeTransitRouteTableAggregation查询企业版转发路由器路由表下的聚合路由查询企业版转发路由器路由表下的聚合路由。

前缀列表

API标题API概述
CreateTransitRouterPrefixListAssociation为企业版转发路由器路由表绑定前缀列表为企业版转发路由器路由表绑定前缀列表。
DeleteTransitRouterPrefixListAssociation解除企业版转发路由器路由表与前缀列表的绑定关系解除企业版转发路由器路由表与前缀列表的绑定关系。
ListTransitRouterPrefixListAssociation查询企业版转发路由器路由表绑定的前缀列表的信息查询企业版转发路由器路由表绑定的前缀列表的信息。

流量调度

API标题API概述
流量标记策略流量标记策略
AddTraficMatchRuleToTrafficMarkingPolicy为流量标记策略添加流分类规则为流量标记策略添加流分类规则。
AddTrafficMatchRuleToTrafficMarkingPolicy为流量标记策略添加流分类规则为流量标记策略添加流分类规则。
CreateTrafficMarkingPolicy创建流量标记策略创建流量标记策略。
DeleteTrafficMarkingPolicy删除流量标记策略删除流量标记策略。
UpdateTrafficMarkingPolicyAttribute修改流量标记策略的名称,描述信息以及流分类规则修改流量标记策略的名称,描述信息以及流分类规则。
ListTrafficMarkingPolicies查询流量标记策略的信息查询流量标记策略的信息。
RemoveTraficMatchRuleFromTrafficMarkingPolicy删除流量标记策略下的流分类规则删除流量标记策略下的流分类规则。
RemoveTrafficMatchRuleFromTrafficMarkingPolicy删除流量标记策略下的流分类规则删除流量标记策略下的流分类规则。
流量调度策略流量调度策略
CreateCenInterRegionTrafficQosQueue创建流量调度策略下队列的配置创建流量调度策略下队列的配置。
CreateCenInterRegionTrafficQosPolicy创建跨地域流量调度策略创建跨地域流量调度策略。
DeleteCenInterRegionTrafficQosQueue删除流量调度策略下的队列删除流量调度策略下的队列。
DeleteCenInterRegionTrafficQosPolicy删除流量调度策略删除流量调度策略。
UpdateCenInterRegionTrafficQosQueueAttribute修改流量调度策略下队列的配置修改流量调度策略下队列的配置。
UpdateCenInterRegionTrafficQosPolicyAttribute修改流量调度策略的名称和描述信息修改流量调度策略的名称和描述信息。
ListCenInterRegionTrafficQosPolicies查询流量调度策略的信息查询流量调度策略的信息。
ListCenInterRegionTrafficQosQueues查询流量调度策略队列的信息查询流量调度策略队列的信息。

云服务

API标题API概述
DeleteRouteServiceInCen删除云服务删除云服务配置。
DescribeRouteServicesInCen查询云服务查询云企业网实例的云服务配置信息。
ResolveAndRouteServiceInCen设置云服务为本地网络添加访问云服务的配置。

PrivateZone

API标题API概述
DescribeCenPrivateZoneRoutes查询PrivateZone查询云企业网实例的PrivateZone服务配置信息。
UnroutePrivateZoneInCenToVpc删除PrivateZone删除PrivateZone服务配置。
RoutePrivateZoneInCenToVpc设置PrivateZone设置访问PrivateZone服务。

组播

API标题API概述
组播域组播域
CreateTransitRouterMulticastDomain创建组播域创建组播域。
DeleteTransitRouterMulticastDomain删除组播域删除组播域。
ModifyTransitRouterMulticastDomain修改组播域的名称和描述信息修改组播域的名称和描述信息。
ListTransitRouterMulticastDomains查询组播域的信息查询组播域的信息。
ListTransitRouterMulticastDomainAssociations查询组播域的关联信息查询组播域的关联信息。
ListTransitRouterMulticastDomainVSwitches查询专有网络VPC实例下已关联组播域的交换机的信息查询专有网络VPC(Virtual Private Cloud)实例下已关联组播域的交换机的信息。
AssociateTransitRouterMulticastDomain将专有网络VPC下的交换机关联至组播域将专有网络VPC(Virtual Private Cloud)下的交换机关联至组播域。
DisassociateTransitRouterMulticastDomain解除交换机与组播域的关联关系解除交换机与组播域的关联关系。
组播源和组播成员组播源和组播成员
ListTransitRouterMulticastGroups查询组播域下组播成员和组播源的信息查询组播域下组播成员和组播源的信息。
ListGrantVSwitchEnis查询专有网络VPC(Virtual Private Cloud)下可以成为组播源或者组播成员的弹性网卡的信息查询专有网络VPC(Virtual Private Cloud)下可以成为组播源或者组播成员的弹性网卡的信息。
DeregisterTransitRouterMulticastGroupMembers删除组播成员删除组播成员。
RegisterTransitRouterMulticastGroupSources创建组播源创建组播源。
DeregisterTransitRouterMulticastGroupSources删除组播源删除组播源。
RegisterTransitRouterMulticastGroupMembers创建组播成员创建组播成员。

健康检查

API标题API概述
DisableCenVbrHealthCheck关闭边界路由器(VBR)健康检查关闭指定边界路由器(VBR)的健康检查。
EnableCenVbrHealthCheck开启边界路由器(VBR)健康检查功能开启边界路由器(VBR)的健康检查功能,确保及时发现出现故障的物理专线,也可修改VBR的健康检查配置。
DescribeCenVbrHealthCheck查询边界路由器(VBR)健康检查信息查询指定地域内边界路由器(VBR)健康检查信息。

流日志

API标题API概述
CreateFlowlog创建流日志创建流日志。
DeleteFlowlog删除流日志删除流日志。
ModifyFlowLogAttribute编辑流日志的名称和描述编辑流日志的名称和描述。
DescribeFlowlogs查询流日志查询流日志。
ActiveFlowLog启动流日志启动流日志,启动后开始捕获指定资源的流量。
DeactiveFlowLog停止流日志停止流日志,停止后不再捕获指定资源的流量。

标签

API标题API概述
ListTagResources查询CEN实例已经绑定的标签列表查询云企业网实例绑定的标签信息。
TagResources为指定的实例创建并绑定标签为资源创建并绑定标签。
UntagResources为指定的资源列表统一解绑并删除标签为资源解绑标签。
阿里云首页 云企业网 相关技术圈