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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeSnatTableEntries

要执行的操作。取值:DescribeSnatTableEntries

RegionId String cn-hangzhou

NAT网关所在的地域ID。

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

SnatTableId String stb-8vbczigrhop8x5u3t****

SNAT表ID。

SnatEntryId String snat-8vbae8uqh7rjpk7d2****

SNAT条目ID。

SourceVSwitchId String vsw-3xbjkhjshjdf****

交换机的ID。

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

SNAT条目的源网段。

SnatIp String 116.22.XX.XX
  • 当查询公网NAT网关的SNAT条目时,该参数为SNAT条目中的EIP。
  • 当查询VPC NAT网关的SNAT条目时,该参数为SNAT条目中的NAT IP地址。
SnatEntryName String SnatEntry-1

SNAT条目的名称。

长度为2~128个字符,必须以字母或中文开头,但不能以http://https://开头。

PageNumber Integer 1

列表的页码,默认值为1

PageSize Integer 10

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

返回数据

名称 类型 示例值 描述
SnatTableEntries Array of SnatTableEntry

查询的SNAT列表详细信息。

SnatTableEntry
SnatEntryId String snat-kmd6nv8fy****

SNAT条目的ID。

SnatEntryName String SnatEntry-1

SNAT条目的名称。

SnatIp String 116.22.XX.XX
  • 当查询公网NAT网关的SNAT条目时,该返回参数为SNAT条目中的EIP。
  • 当查询VPC NAT网关的SNAT条目时,该返回参数为SNAT条目中的NAT IP地址。
SnatTableId String stb-gz3r3odawdgffde****

SNAT条目所属的SNAT表ID。

SourceCIDR String 116.22.XX.XX/24

SNAT条目的源网段。

SourceVSwitchId String vsw-3xbdsffvfgdfds****
  • 当查询公网NAT网关时,该返回参数为通过SNAT功能访问互联网的交换机ID。
  • 当查询VPC NAT网关时,该返回参数为通过SNAT功能访问外部网络的交换机ID。
Status String Pending

SNAT条目状态,取值:

  • Pending:配置中,可能是创建中或修改中。
  • Available:可用。
  • Deleting:删除中。
TotalCount Integer 1

列表条目数。

PageNumber Integer 1

当前页码。

PageSize Integer 5

每页包含的条目数。

RequestId String 6D7E89B1-1C5B-412B-8585-4908E222EED5

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeSnatTableEntries
&RegionId=cn-hangzhou
&SnatTableId=stb-8vbczigrhop8x5u3t****
&<公共请求参数>

正常返回示例

XML格式

<DescribeSnatTableEntriesResponse>
  <TotalCount>1</TotalCount>
  <PageSize>5</PageSize>
  <RequestId>6D7E89B1-1C5B-412B-8585-4908E222EED5</RequestId>
  <PageNumber>1</PageNumber>
  <SnatTableEntries>
        <SnatTableEntry>
              <Status>Pending</Status>
              <SourceVSwitchId>vsw-3xbdsffvfgdfds****</SourceVSwitchId>
              <SnatEntryName>SnatEntry-1</SnatEntryName>
              <SourceCIDR>116.22.XX.XX/24</SourceCIDR>
              <SnatEntryId>snat-kmd6nv8fy****</SnatEntryId>
              <SnatIp>116.22.XX.XX</SnatIp>
              <SnatTableId>stb-gz3r3odawdgffde****</SnatTableId>
        </SnatTableEntry>
  </SnatTableEntries>
</DescribeSnatTableEntriesResponse>

JSON格式

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

错误码

HttpCode 错误码 错误信息 描述
404 InvalidRegionId.NotFound The specified RegionId does not exist in our records. 指定的RegionId不存在。
404 InvalidSnatTableId.NotFound Specified SNAT table does not exist. 指定的 SNAT 表不存在,请您检查输入参数是否正确。

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