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

NAT

API

标题

API概述

Nat网关 Nat网关
CreateNatGateway 创建NAT网关 调用CreateNatGateway接口创建增强型公网NAT网关或VPC NAT网关。
DeleteNatGateway 删除指定的NAT网关 调用DeleteNatGateway接口删除指定的公网NAT网关。
ModifyNatGatewayAttribute 修改NAT网关的属性 调用ModifyNatGatewayAttribute接口修改NAT网关的属性。
ModifyNatGatewaySpec 接口修改NAT网关的规格 使用ModifyNatGatewaySpec接口修改预付费公网NAT网关的规格。
DescribeNatGateways 查询已创建的NAT网关 调用DescribeNatGateways以列表形式查询指定地域指定条件NAT网关的详细信息。
GetNatGatewayAttribute 查看单个NAT网关实例详细信息 调用GetNatGatewayAttribute接口查询单个NAT网关实例的信息。
ListEnhanhcedNatGatewayAvailableZones 查询增强型NAT网关的资源可用区 调用ListEnhanhcedNatGatewayAvailableZones接口查询NAT网关的资源可用区。
DescribeNatGatewayAssociateNetworkInterfaces 查询VPC NAT关联的弹性网卡列表 VPC NAT网关作为服务资源对象被私网连接服务引用场景下,查询VPC NAT关联的弹性网卡列表,目前该特性暂不开放使用。
VpcDescribeVpcNatGatewayNetworkInterfaceQuota 查询反向访问VPC NAT当前可以创建的EP个数 调用VpcDescribeVpcNatGatewayNetworkInterfaceQuota接口查询反向访问VPC NAT当前可以创建的EP个数。
SNAT规则 SNAT规则
CreateSnatEntry SNAT列表中添加SNAT条目 调用CreateSnatEntry接口在SNAT列表中添加SNAT条目。
DeleteSnatEntry 删除指定的SNAT条目 调用DeleteSnatEntry接口删除指定的SNAT条目。
ModifySnatEntry 修改指定的SNAT条目 调用ModifySnatEntry接口修改指定的SNAT条目。
DescribeSnatTableEntries 查询已创建的SNAT条目 调用DescribeSnatTableEntries接口查询已创建的SNAT条目。
DNAT规则 DNAT规则
CreateForwardEntry DNAT列表中添加DNAT条目 调用CreateForwardEntry接口在DNAT列表中添加DNAT条目。
DeleteForwardEntry 删除指定的DNAT条目 调用DeleteForwardEntry接口删除指定的DNAT条目。
ModifyForwardEntry 修改指定的DNAT条目 调用ModifyForwardEntry接口修改指定的DNAT条目。
DescribeForwardTableEntries 查询已创建的DNAT条目 调用DescribeForwardTableEntries接口查询已创建的DNAT条目。
FullNAT规则 FullNAT规则
CreateFullNatEntry 添加FULLNAT条目 调用CreateFullNatEntry接口在FULLNAT列表中添加FULLNAT条目。
DeleteFullNatEntry 删除FULLNAT条目 调用DeleteFullNatEntry接口删除FULLNAT条目。
ModifyFullNatEntryAttribute 修改FULLNAT条目 调用ModifyFullNatEntryAttribute接口修改FULLNAT条目。
ListFullNatEntries 查询FULLNAT条目的列表信息 调用ListFullNatEntries接口查询FULLNAT条目的列表信息。
NatIp管理 NatIp管理
NatIp NatIp
CreateNatIp 创建NAT IP地址 VPC NAT网关实例创建NAT IP地址。
DeleteNatIp 删除NAT IP地址 调用DeleteNatIp接口删除NAT IP地址。
ModifyNatIpAttribute 修改NAT IP地址的名称和描述 调用ModifyNatIpAttribute接口修改NAT IP地址的名称和描述。
ListNatIps 查询NAT IP地址列表 调用ListNatIps接口查询NAT IP地址列表。
NatIpCidr NatIpCidr
CreateNatIpCidr 创建NAT IP地址段 VPC NAT网关实例创建NAT IP地址段。
DeleteNatIpCidr 删除NAT IP地址段 调用DeleteNatIpCidr接口删除NAT IP地址段。
ModifyNatIpCidrAttribute 修改NAT IP地址段的名称和描述 调用ModifyNatIpCidrAttribute接口修改NAT IP地址段的名称和描述。
ListNatIpCidrs 查询NAT IP地址段列表 调用ListNatIpCidrs接口查询NAT IP地址段列表。