调用DescribeSnatTableEntries查询已创建的SNAT条目_NAT网关(NAT Gateway)-阿里云帮助中心

调用DescribeSnatTableEntries接口查询已创建的SNAT条目。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
vpc:DescribeSnatTableEntries	get	*SnatTable `acs:vpc:{#regionId}:{#accountId}:snattable/{#SnatTableId}`	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	NAT 网关所在的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-hangzhou
SnatTableId	string	否	SNAT 表 ID。说明 SnatTableId 和 NatGatewayId 参数至少输入一个。	stb-8vbczigrhop8x5u3t****
SnatEntryId	string	否	SNAT 条目 ID。	snat-8vbae8uqh7rjpk7d2****
SourceVSwitchId	string	否	交换机的 ID。当查询公网 NAT 网关的 SNAT 条目时，该参数表示该交换机内的 ECS 实例均可以通过 SNAT 规则访问公网。当查询 VPC NAT 网关的 SNAT 条目时，该参数表示该交换机内的 ECS 实例均可以通过 SNAT 规则访问外部网络。	vsw-3xbjkhjshjdf****
SourceCIDR	string	否	SNAT 条目的源网段。	116.22.XX.XX/24
SnatIp	string	否	当查询公网 NAT 网关的 SNAT 条目时，该参数为 SNAT 条目中的 EIP。当查询 VPC NAT 网关的 SNAT 条目时，该参数为 SNAT 条目中的 NAT IP 地址。	116.22.XX.XX
SnatEntryName	string	否	SNAT 条目的名称。名称长度为 2~128 个字符，以大小写字母或中文开头，可包含数字、下划线（_）和短划线（-）。	SnatEntry-1
PageNumber	integer	否	列表的页码，默认值为 1。	1
PageSize	integer	否	分页查询时每页的行数，最大值为 50，默认值为 10。	10
NatGatewayId	string	否	要查询的 NAT 网关的 ID。说明 SnatTableId 和 NatGatewayId 参数至少输入一个。	ngw-bp1uewa15k4iy5770****
NetworkInterfaceIds	array	否	要查询的弹性网卡 ID。
	string	否	弹性网卡 ID。	eni-gw8g131ef2dnbu3k****

返回参数

名称	类型	描述	示例值
	object
PageSize	integer	每页包含的条目数。	5
RequestId	string	请求 ID。	6D7E89B1-1C5B-412B-8585-4908E222EED5
PageNumber	integer	当前页码。	1
TotalCount	integer	列表条目数。	1
SnatTableEntries	array<object>	查询的 SNAT 列表详细信息。
SnatTableEntry	object	SNAT 列表的详细信息。
Status	string	SNAT 条目状态，取值： Pending：配置中，可能是创建中或修改中。 Available：可用。 Deleting：删除中。	Pending
SnatEntryName	string	SNAT 条目的名称。	SnatEntry-1
SourceVSwitchId	string	当查询公网 NAT 网关时，该返回参数为通过 SNAT 功能访问互联网的交换机 ID。当查询 VPC NAT 网关时，该返回参数为通过 SNAT 功能访问外部网络的交换机 ID。	vsw-3xbdsffvfgdfds****
SourceCIDR	string	SNAT 条目的源网段。	116.22.XX.XX/24
SnatEntryId	string	SNAT 条目的 ID。	snat-kmd6nv8fy****
SnatTableId	string	SNAT 条目所属的 SNAT 表 ID。	stb-gz3r3odawdgffde****
SnatIp	string	当查询公网 NAT 网关的 SNAT 条目时，该返回参数为 SNAT 条目中的 EIP。当查询 VPC NAT 网关的 SNAT 条目时，该返回参数为 SNAT 条目中的 NAT IP 地址。	116.22.XX.XX
NatGatewayId	string	SNAT 条目所属的 NAT 网关的 ID。	ngw-bp1uewa15k4iy5770****
EipAffinity	string	是否打开 IP 亲和性。取值： 0：关闭 IP 亲和性。 1：打开 IP 亲和性。说明打开 IP 亲和性开关后，如果 SNAT 条目绑定多个 EIP 或 NAT IP，同一个客户端将使用相同的 EIP 或 NAT IP 进行访问，否则客户端将从绑定的 EIP 或 NAT IP 中随机选取进行访问。	1
NetworkInterfaceId	string	弹性网卡 ID。	eni-gw8g131ef2dnbu3k****

示例

正常返回示例

JSON格式

{
  "PageSize": 5,
  "RequestId": "6D7E89B1-1C5B-412B-8585-4908E222EED5",
  "PageNumber": 1,
  "TotalCount": 1,
  "SnatTableEntries": {
    "SnatTableEntry": [
      {
        "Status": "Pending",
        "SnatEntryName": "SnatEntry-1",
        "SourceVSwitchId": "vsw-3xbdsffvfgdfds****",
        "SourceCIDR": "116.22.XX.XX/24",
        "SnatEntryId": "snat-kmd6nv8fy****",
        "SnatTableId": "stb-gz3r3odawdgffde****",
        "SnatIp": "116.22.XX.XX",
        "NatGatewayId": "ngw-bp1uewa15k4iy5770****",
        "EipAffinity": "1",
        "NetworkInterfaceId": "eni-gw8g131ef2dnbu3k****"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidName.Malformed	The specified Name is not valid.	参数Name值不合法
400	DESCRIBE_SNAT_PARAM_INVALID	SnatTableId and natGatewayId can not both be null	-
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.	指定的RegionId不存在。
404	InvalidSnatTableId.NotFound	Specified SNAT table does not exist.	指定的 SNAT 表不存在，请您检查输入参数是否正确。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-08-09	OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-05-06	OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-08-09	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-03-01	OpenAPI 错误码发生变更	查看变更详情