文档

DescribeSnatTableEntries - 查询已创建的SNAT条目

更新时间:

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:DescribeSnatTableEntriesRead
  • SnatTable
    acs:vpc:{#regionId}:{#accountId}:snattable/{#SnatTableId}

请求参数

名称类型必填描述示例值
RegionIdstring

NAT 网关所在的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou
SnatTableIdstring

SNAT 表 ID。

说明 SnatTableIdNatGatewayId 参数至少输入一个。
stb-8vbczigrhop8x5u3t****
SnatEntryIdstring

SNAT 条目 ID。

snat-8vbae8uqh7rjpk7d2****
SourceVSwitchIdstring

交换机的 ID。

  • 当查询公网 NAT 网关的 SNAT 条目时,该参数表示该交换机内的 ECS 实例均可以通过 SNAT 规则访问公网。

  • 当查询 VPC NAT 网关的 SNAT 条目时,该参数表示该交换机内的 ECS 实例均可以通过 SNAT 规则访问外部网络。

vsw-3xbjkhjshjdf****
SourceCIDRstring

SNAT 条目的源网段。

116.22.XX.XX/24
SnatIpstring
  • 当查询公网 NAT 网关的 SNAT 条目时,该参数为 SNAT 条目中的 EIP。

  • 当查询 VPC NAT 网关的 SNAT 条目时,该参数为 SNAT 条目中的 NAT IP 地址。

116.22.XX.XX
SnatEntryNamestring

SNAT 条目的名称。

名称长度为 2~128 个字符,以大小写字母或中文开头, 可包含数字、下划线(_)和短划线(-)。

SnatEntry-1
PageNumberinteger

列表的页码,默认值为 1

1
PageSizeinteger

分页查询时每页的行数,最大值为 50,默认值为 10

10
NatGatewayIdstring

要查询的 NAT 网关的 ID。

说明 SnatTableIdNatGatewayId 参数至少输入一个。
ngw-bp1uewa15k4iy5770****

返回参数

名称类型描述示例值
object
PageSizeinteger

每页包含的条目数。

5
RequestIdstring

请求 ID。

6D7E89B1-1C5B-412B-8585-4908E222EED5
PageNumberinteger

当前页码。

1
TotalCountinteger

列表条目数。

1
SnatTableEntriesobject []

查询的 SNAT 列表详细信息。

Statusstring

SNAT 条目状态,取值:

  • Pending:配置中,可能是创建中或修改中。

  • Available:可用。

  • Deleting:删除中。

Pending
SnatEntryNamestring

SNAT 条目的名称。

SnatEntry-1
SourceVSwitchIdstring
  • 当查询公网 NAT 网关时,该返回参数为通过 SNAT 功能访问互联网的交换机 ID。

  • 当查询 VPC NAT 网关时,该返回参数为通过 SNAT 功能访问外部网络的交换机 ID。

vsw-3xbdsffvfgdfds****
SourceCIDRstring

SNAT 条目的源网段。

116.22.XX.XX/24
SnatEntryIdstring

SNAT 条目的 ID。

snat-kmd6nv8fy****
SnatTableIdstring

SNAT 条目所属的 SNAT 表 ID。

stb-gz3r3odawdgffde****
SnatIpstring
  • 当查询公网 NAT 网关的 SNAT 条目时,该返回参数为 SNAT 条目中的 EIP。

  • 当查询 VPC NAT 网关的 SNAT 条目时,该返回参数为 SNAT 条目中的 NAT IP 地址。

116.22.XX.XX
NatGatewayIdstring

SNAT 条目所属的 NAT 网关的 ID。

ngw-bp1uewa15k4iy5770****

示例

正常返回示例

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": ""
      }
    ]
  }
}

错误码

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

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

变更历史

变更时间变更内容概要操作
2024-05-06OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
出参OpenAPI 返回结构发生变更
2023-08-09OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
出参OpenAPI 返回结构发生变更
2023-03-01OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
  • 本页导读 (1)