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 策略。仅在明确需要阿里云账号权限的特定场景下,才使用阿里云账号。

专有网络(VPC)

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、VBRCCN)的云企业网跨账号授权信息。

路由器

API

标题

API概述

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

交换机

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概述

CreateRouteEntry 创建自定义路由条目 调用CreateRouteEntryVPC路由器或边界路由器(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概述

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

DHCP选项集

API

标题

API概述

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

流日志

API

标题

API概述

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

网络ACL

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概述

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概述

流量镜像过滤器规则 流量镜像过滤器规则
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接口查询流量镜像功能的状态。

路由目标组

API

标题

API概述

SwitchActiveRouteTarget 路由目标组主备切换 路由目标组主备切换。
UpdateRouteTargetGroup 更新路由目标组 更新路由目标组实例信息,包括名称、描述、未使能的成员。
ListRouteTargetGroups 查询路由目标组列表 查询路由目标组列表。
GetRouteTargetGroup 查询路由目标组 获取路由目标组实例信息。
DeleteRouteTargetGroup 删除路由目标组 删除路由目标组实例。
CreateRouteTargetGroup 创建路由目标组 创建路由目标组实例。

IPv6网关

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实例,调用CreateIpv6EgressOnlyRuleIPv6地址添加仅主动出规则。
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概述

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

标签

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概述

CreateVpcGatewayEndpoint 创建网关终端节点 调用CreateVpcGatewayEndpoint接口创建网关终端节点。
DeleteVpcGatewayEndpoint 删除网关终端节点 调用DeleteVpcGatewayEndpoint接口删除网关终端节点。
UpdateVpcGatewayEndpointAttribute 修改网关终端节点的配置信息 调用UpdateVpcGatewayEndpointAttribute接口修改网关终端节点的配置信息。
ListVpcEndpointServicesByEndUser 查询可使用的终端节点服务 调用ListVpcEndpointServicesByEndUser查询可使用的终端节点服务。
GetVpcGatewayEndpointAttribute 查询网关终端节点的属性 调用GetVpcGatewayEndpointAttribute接口查询网关终端节点的属性。
ListVpcGatewayEndpoints 查询VPC网关端点列表 调用ListVpcGatewayEndpoints接口查询已创建的网关终端节点的列表。
AssociateRouteTablesWithVpcGatewayEndpoint 关联路由表与网关终端节点 调用AssociateRouteTablesWithVpcGatewayEndpoint接口关联路由表与网关终端节点。
DissociateRouteTablesFromVpcGatewayEndpoint 将网关终端节点与路由表解绑 调用DissociateRouteTablesFromVpcGatewayEndpoint接口将网关终端节点与路由表解绑。

资源组

API

标题

API概述

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