API概览

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

专有网络(VPC)

API标题API概述
API标题API概述
CreateVpc创建一个VPC创建一个专有网络VPC。
CreateDefaultVpc创建一个默认的VPC创建一个默认的专有网络VPC。
GrantInstanceToCen为云企业网实例授权为云企业网实例授权。
AssociateVpcCidrBlock为VPC添加附加网段为VPC添加附加网段。
AllocateVpcIpv6Cidr预留指定的IPv6地址段预留指定的IPv6地址段。
DeleteVpc删除一个VPC调用DeleteVpc接口删除一个专有网络VPC(Virtual Private Cloud)。
RevokeInstanceFromCen撤销网络实例对指定云企业网实例的授权调用RevokeInstanceFromCen撤销网络实例对指定云企业网实例的授权。
UnassociateVpcCidrBlock删除VPC的附加网段调用UnassociateVpcCidrBlock删除VPC的附加网段。
ModifyVpcAttribute修改指定VPC的名称和描述信息修改指定VPC的名称和描述信息。
EnableVpcClassicLink开启ClassicLink开启ClassicLink。
DisableVpcClassicLink关闭ClassicLink关闭ClassicLink。
DeletionProtection实例释放保护设置实例删除保护功能。
DescribeVpcs查询已创建的VPC查询已创建的VPC。
DescribeVpcAttribute查询指定VPC的配置信息查询指定VPC的配置信息。
DescribeGrantRulesToCen查询云企业网跨账号授权信息查询指定网络实例(VPC、VBR和CCN)的云企业网跨账号授权信息。

路由器

API标题API概述
API标题API概述
ModifyVRouterAttribute修改路由器的名称和描述信息调用ModifyVRouterAttribute接口修改路由器的名称和描述信息。
DescribeVRouters查询指定地域的路由器列表调用DescribeVRouters接口查询指定地域的路由器列表。

交换机

API标题API概述
API标题API概述
ListVSwitchCidrReservations查询交换机预留网段查询交换机预留网段。
CreateVSwitchCidrReservation创建交换机预留网段调用CreateVSwitchCidrReservation接口创建交换机预留网段。
GetVSwitchCidrReservationUsage查询交换机预留网段的用量情况查询交换机预留网段的用量。
ModifyVSwitchCidrReservationAttribute修改交换机预留网段的名称和描述信息修改交换机预留网段的名称和描述信息。
CreateVSwitch创建交换机创建一个交换机。
CreateDefaultVSwitch创建默认交换机调用CreateDefaultVSwitch接口创建一个默认的交换机。
CheckCanAllocateVpcPrivateIpAddress查询交换机下的私网IP可用性调用CheckCanAllocateVpcPrivateIpAddress接口查询交换机下的私网IP地址是否可用。
DeleteVSwitch删除交换机调用DeleteVSwitch接口删除交换机。
ModifyVSwitchAttribute修改指定交换机的名称和描述信息调用ModifyVSwitchAttribute接口修改指定交换机的名称和描述信息。
DescribeVSwitches查询可组网信息查询可组网的信息,内网按vswitch进行组网。
DescribeVSwitchAttributes查询指定交换机的配置信息调用DescribeVSwitchAttributes接口查询指定交换机的配置信息。
DeleteVSwitchCidrReservation删除交换机预留网段删除交换机预留网段。

路由表

API标题API概述
API标题API概述
CreateRouteEntry创建自定义路由条目调用CreateRouteEntry在VPC路由器或边界路由器(VBR)上创建自定义路由条目。
CreateRouteEntries批量添加自定义路由条目在VPC路由器的路由表中批量添加自定义路由条目。
CreateRouteTable创建自定义路由表创建自定义路由表。
AssociateRouteTable将路由表和交换机绑定将创建的自定义路由表和同一VPC内的交换机绑定。
DeleteRouteEntry删除自定义路由条目调用DeleteRouteEntry删除VPC路由器或边界路由器的路由表中的路由条目。
DeleteRouteEntries批量删除自定义路由条目调用DeleteRouteEntries批量删除自定义路由条目。
DeleteRouteTable删除自定义路由表调用DeleteRouteTable接口删除自定义路由表。
UnassociateRouteTable将路由表和交换机解绑调用UnassociateRouteTable接口将路由表和交换机解绑。
ModifyRouteTableAttributes修改路由表的名称和描述修改路由表的名称、描述,或者修改是否接收动态路由。
ModifyRouteEntry修改自定义路由条目的名称描述或者路由下一跳调用ModifyRouteEntry修改自定义路由条目的名称、描述和路由下一跳。
GetVpcRouteEntrySummary查询路由类型的明细调用GetVpcRouteEntrySummary接口查询路由类型的明细。
DescribeRouteTables查询路由表调用DescribeRouteTables接口查询路由表。
DescribeRouteEntryList查询路由条目列表调用DescribeRouteEntryList查询路由条目列表。
DescribeRouteTableList查询路由表调用DescribeRouteTableList接口查询路由表列表。
ListVpcPublishedRouteEntries查询VPC路由发布状态查询路由发布情况。
PublishVpcRouteEntries发布VPC路由发布VPC路由到外部组件。
WithdrawVpcPublishedRouteEntries撤回VPC已发布路由撤回VPC已发布路由。
ListGatewayRouteTableEntries查询网关路由表列表信息调用ListGatewayRouteTableEntries接口查询网关路由表列表信息。
AssociateRouteTableWithGateway绑定网关路由表和网关调用AssociateRouteTableWithGateway接口将网关路由表和同一VPC内的IPv4网关、IPv6网关实例绑定。
DissociateRouteTableFromGateway解绑网关路由表和网关调用DissociateRouteTableFromGateway解绑网关路由表和IPv4网关、IPv6网关实例。
UpdateGatewayRouteTableEntryAttribute修改网关路由表的下一跳类型和下一跳修改网关路由表的下一跳类型和下一跳。

前缀列表

API标题API概述
API标题API概述
CreateVpcPrefixList创建前缀列表调用CreateVpcPrefixList接口创建前缀列表。
RetryVpcPrefixListAssociation重新下发最新的前缀列表调用RetryVpcPrefixListAssociation接口重新下发最新的前缀列表。
DeleteVpcPrefixList删除前缀列表调用DeleteVpcPrefixList接口删除前缀列表。
ModifyVpcPrefixList修改前缀列表的配置信息调用ModifyVpcPrefixList接口修改前缀列表的配置信息。
ListPrefixLists查询前缀列表的列表信息调用ListPrefixLists接口查询前缀列表的列表信息。
GetVpcPrefixListAssociations查询前缀列表的关联关系调用GetVpcPrefixListAssociations接口查询前缀列表的关联关系。
GetVpcPrefixListEntries查询指定前缀列表的信息调用GetVpcPrefixListEntries接口查询指定前缀列表的信息。

DHCP选项集

API标题API概述
API标题API概述
CreateDhcpOptionsSet创建DHCP选项集创建DHCP选项集。
DeleteDhcpOptionsSet删除DHCP选项集调用DeleteDhcpOptionsSet接口删除DHCP选项集。
AttachDhcpOptionsSetToVpc将DHCP选项集关联到VPC调用AttachDhcpOptionsSetToVpc接口将DHCP选项集关联到VPC。
DetachDhcpOptionsSetFromVpc将DHCP选项集与VPC取消关联调用DetachDhcpOptionsSetFromVpc接口将DHCP选项集与VPC取消关联。
ReplaceVpcDhcpOptionsSet更改DHCP选项集与VPC的关联调用ReplaceVpcDhcpOptionsSet接口更改DHCP选项集与VPC的关联。
UpdateDhcpOptionsSetAttribute修改DHCP选项集配置信息调用UpdateDhcpOptionsSetAttribute接口修改DHCP选项集配置信息。
GetDhcpOptionsSet查询已创建的DHCP选项集调用GetDhcpOptionsSet接口查询已创建的DHCP选项集。
ListDhcpOptionsSets查询已创建的DHCP选项集列表调用ListDhcpOptionsSets接口查询已创建的DHCP选项集列表。

流日志

API标题API概述
API标题API概述
OpenFlowLogService开通流日志功能调用OpenFlowLogService接口开通流日志功能。
CreateFlowLog创建流日志创建流日志。
DeleteFlowLog删除流日志调用DeleteFlowLog接口删除流日志。
ModifyFlowLogAttribute编辑流日志的名称和描述 调用ModifyFlowLogAttribute接口编辑流日志的名称和描述。
ActiveFlowLog启动流日志调用ActiveFlowLog接口启动流日志,启动后开始捕获指定资源的流量。
DeactiveFlowLog停止流日志调用DeactiveFlowLog接口停止流日志,停止后不再捕获指定资源的流量。
GetFlowLogServiceStatus查询流日志功能的开通状态调用GetFlowLogServiceStatus接口查询流日志功能的开通状态。
DescribeFlowLogs查询流日志调用DescribeFlowLogs接口查询流日志。

网络ACL

API标题API概述
API标题API概述
AssociateNetworkAcl绑定网络ACL到交换机调用AssociateNetworkAcl接口,绑定网络ACL到交换机。
CreateNetworkAcl创建网络ACL调用CreateNetworkAcl接口创建网络ACL。
CopyNetworkAclEntries复制网络ACL规则调用CopyNetworkAclEntries接口复制网络ACL规则。
DeleteNetworkAcl删除网络ACL调用DeleteNetworkAcl接口删除网络ACL。
UnassociateNetworkAcl解除网络ACL与交换机的绑定调用UnassociateNetworkAcl接口解除网络ACL与交换机的绑定。
ModifyNetworkAclAttributes修改网络ACL的属性调用ModifyNetworkAclAttributes接口修改网络ACL的属性。
UpdateNetworkAclEntries更新网络ACL规则调用UpdateNetworkAclEntries接口更新网络ACL规则。
DescribeNetworkAclAttributes查询网络ACL的详细信息调用DescribeNetworkAclAttributes接口查询网络ACL的详细信息。
DescribeNetworkAcls查看网络ACL列表调用DescribeNetworkAcls接口查看网络ACL列表。

高可用虚拟IP

API标题API概述
API标题API概述
CreateHaVip创建高可用虚拟IP(HaVip)调用CreateHaVip接口创建高可用虚拟IP(HaVip)。
AssociateHaVip将HaVip绑定到专有网络ECS实例上调用AssociateHaVip接口将HaVip绑定到专有网络ECS实例或弹性网卡上。
DeleteHaVip删除高可用虚拟IP(HaVip)调用DeleteHaVip接口删除高可用虚拟IP(HaVip)。
UnassociateHaVip将HaVip与专有网络ECS实例解绑调用UnassociateHaVip 接口将HaVip与专有网络ECS实例或弹性网卡解绑。
ModifyHaVipAttribute修改HaVip实例的名称和描述调用ModifyHaVipAttribute接口修改HaVip实例的名称和描述。
DescribeHaVips查询地域内的高可用虚拟IP(HaVip)调用DescribeHaVips接口查询指定地域内的高可用虚拟IP(HaVip)。

流量镜像

API标题API概述
API标题API概述
流量镜像过滤器规则流量镜像过滤器规则
CreateTrafficMirrorFilterRules创建流量镜像入方向或出方向规则调用CreateTrafficMirrorFilterRules接口创建流量镜像入方向或出方向规则。
DeleteTrafficMirrorFilterRules删除流量镜像筛选条件的入方向或者出方向规则调用DeleteTrafficMirrorFilterRules删除流量镜像筛选条件的入方向或者出方向规则。
UpdateTrafficMirrorFilterRuleAttribute修改流量镜像入方向或出方向规则的配置信息调用UpdateTrafficMirrorFilterRuleAttribute接口修改流量镜像入方向或出方向规则的配置信息。
流量镜像过滤器流量镜像过滤器
CreateTrafficMirrorFilter创建流量镜像筛选条件调用CreateTrafficMirrorFilter接口创建流量镜像筛选条件。
DeleteTrafficMirrorFilter删除流量镜像筛选条件调用DeleteTrafficMirrorFilter接口删除流量镜像筛选条件。
UpdateTrafficMirrorFilterAttribute修改流量镜像筛选条件的配置信息调用UpdateTrafficMirrorFilterAttribute接口修改流量镜像筛选条件的配置信息。
ListTrafficMirrorFilters查询流量镜像的筛选条件查询流量镜像的筛选条件。
流量镜像会话流量镜像会话
AddSourcesToTrafficMirrorSession为镜像会话增加镜像源调用AddSourcesToTrafficMirrorSession接口为镜像会话增加镜像源。
CreateTrafficMirrorSession创建流量镜像会话调用CreateTrafficMirrorSession创建镜像会话。
DeleteTrafficMirrorSession删除流量镜像会话删除镜像会话。
UpdateTrafficMirrorSessionAttribute修改流量镜像会话的配置信息修改镜像会话的配置信息。
ListTrafficMirrorSessions查询镜像会话的详细信息查询镜像会话的详细信息。
RemoveSourcesFromTrafficMirrorSession删除镜像会话中的镜像源调用RemoveSourcesFromTrafficMirrorSession接口删除镜像会话中的镜像源。
OpenTrafficMirrorService开通流量镜像功能开通流量镜像功能。
GetTrafficMirrorServiceStatus查询流量镜像功能的状态调用GetTrafficMirrorServiceStatus接口查询流量镜像功能的状态。

弹性公网IP

API标题API概述
API标题API概述
EIP实例EIP实例
ModifyEipForwardMode修改EIP转发模式修改EIP转发模式。
IP地址池IP地址池
TransformEipSegmentToPublicIpAddressPool连续EIP组迁移至IP地址池将连续EIP组迁移至IP地址池。

IPv4网关

API标题API概述
API标题API概述
CreateIpv4Gateway创建IPv4网关调用CreateIpv4Gateway接口创建IPv4网关。
DeleteIpv4Gateway删除IPv4网关调用DeleteIpv4Gateway接口删除IPv4网关。
EnableVpcIpv4Gateway激活IPv4网关调用EnableVpcIpv4Gateway接口激活IPv4网关。
UpdateIpv4GatewayAttribute修改IPv4网关的名称或描述信息调用UpdateIpv4GatewayAttribut修改IPv4网关的名称或描述信息。
ListIpv4Gateways查询IPv4网关实例的列表信息调用ListIpv4Gateways接口查询IPv4网关实例的列表信息。
GetIpv4GatewayAttribute查询指定的IPv4网关属性调用GetIpv4GatewayAttribute接口

IPv6网关

API标题API概述
API标题API概述
AllocateIpv6Address创建IPv6地址分配一个IPv6地址。
ReleaseIpv6Address释放IPv6地址释放一个未关联实例的IPv6地址。
CreateIpv6Gateway创建IPv6网关IPv6网关是控制专有网络VPC(Virtual Private Cloud)的IPv6网络流量的网关。您可以通过调用CreateIpv6Gateway接口创建IPv6网关。
CreateIpv6EgressOnlyRule为IPv6地址添加仅主动出规则您可以通过创建仅主动出规则,使开通了IPv6网段的VPC中的ECS可以主动访问客户端的IPv6终端,但不允许客户端的IPv6终端通过互联网访问VPC网络中的ECS实例,调用CreateIpv6EgressOnlyRule为IPv6地址添加仅主动出规则。
DeleteIpv6Gateway删除IPv6网关调用DeleteIpv6Gateway接口删除IPv6网关。
DeleteIpv6EgressOnlyRule删除仅主动出规则调用DeleteIpv6EgressOnlyRule接口删除仅主动出规则。
DeleteIpv6InternetBandwidth删除公网带宽调用DeleteIpv6InternetBandwidth接口删除公网带宽。
ModifyIpv6InternetBandwidth修改IPv6地址的公网带宽修改IPv6地址的公网带宽。
ModifyIpv6GatewayAttribute修改IPv6网关的信息修改IPv6网关的信息。
ModifyIpv6AddressAttribute修改IPv6地址的名称和描述修改IPv6地址的名称和描述。
DescribeIpv6Gateways查询已创建的IPv6网关调用DescribeIpv6Gateways接口查询某个地域下已创建的IPv6网关。
DescribeIpv6EgressOnlyRules查询创建的仅主动出规则查询创建的仅主动出规则。
DescribeIpv6Addresses查询IPv6地址列表查询IPv6地址列表。
DescribeIpv6GatewayAttribute查询指定IPv6网关的详细信息调用DescribeIpv6GatewayAttribute接口查询指定IPv6网关所在地域,所属VPC,运行状态,计费方式等详细信息。
AllocateIpv6InternetBandwidth为IPv6地址购买公网带宽默认创建的IPv6网关只具备私网通信的能力,您可以调用AllocateIpv6InternetBandwidth接口为IPv6地址购买公网带宽,使VPC网络中的ECS实例可以通过该IPv6地址访问互联网,同时也允许IPv6终端通过互联网访问VPC网络中的ECS实例。

地域

API标题API概述
API标题API概述
DescribeRegions查询可以使用的阿里云地域调用DescribeRegions接口查询可用的地域。
DescribeZones查询指定地域中可用区的列表调用DescribeZones接口查询指定地域中可用区的列表。

标签

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

路由器接口

API标题API概述
API标题API概述
CreateRouterInterface创建路由器接口调用CreateRouterInterface接口创建路由器接口。
DeleteRouterInterface删除路由器接口调用DeleteRouterInterface接口删除路由器接口。
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概述
API标题API概述
CreateVpcGatewayEndpoint创建网关终端节点调用CreateVpcGatewayEndpoint接口创建网关终端节点。
DeleteVpcGatewayEndpoint删除网关终端节点调用DeleteVpcGatewayEndpoint接口删除网关终端节点。
UpdateVpcGatewayEndpointAttribute修改网关终端节点的配置信息调用UpdateVpcGatewayEndpointAttribute接口修改网关终端节点的配置信息。
ListVpcEndpointServicesByEndUser查询可使用的终端节点服务调用ListVpcEndpointServicesByEndUser查询可使用的终端节点服务。
GetVpcGatewayEndpointAttribute查询网关终端节点的属性调用GetVpcGatewayEndpointAttribute接口查询网关终端节点的属性。
ListVpcGatewayEndpoints查询VPC网关端点列表调用ListVpcGatewayEndpoints接口查询已创建的网关终端节点的列表。
AssociateRouteTablesWithVpcGatewayEndpoint关联路由表与网关终端节点调用AssociateRouteTablesWithVpcGatewayEndpoint接口关联路由表与网关终端节点。
DissociateRouteTablesFromVpcGatewayEndpoint将网关终端节点与路由表解绑调用DissociateRouteTablesFromVpcGatewayEndpoint接口将网关终端节点与路由表解绑。

资源组

API标题API概述
API标题API概述
MoveResourceGroup修改云资源所属的资源组修改云资源所属的资源组。
ChangeResourceGroup修改物理专线资源所属的资源组调用ChangeResourceGroup接口修改物理专线资源所属的资源组。
  • 本页导读 (1)
  • 专有网络(VPC)
  • 路由器
  • 交换机
  • 路由表
  • 前缀列表
  • DHCP选项集
  • 流日志
  • 网络ACL
  • 高可用虚拟IP
  • 流量镜像
  • 弹性公网IP
  • IPv4网关
  • IPv6网关
  • 地域
  • 标签
  • 路由器接口
  • 网关终端节点
  • 资源组
文档反馈