All Products
Search
Document Center

Virtual Private Cloud:DescribeSnatTableEntries

Last Updated:Feb 27, 2024

Queries SNAT entries.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
vpc:DescribeSnatTableEntriesRead
  • SnatTable
    acs:vpc:{#regionId}:{#accountId}:snattable/{#SnatTableId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region where you want to create the NAT gateway.

You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
SnatTableIdstringNo

The ID of the SNAT table.

Note You must specify at least one of SnatTableId and NatGatewayId.
stb-8vbczigrhop8x5u3t****
SnatEntryIdstringNo

The ID of the SNAT entry.

snat-8vbae8uqh7rjpk7d2****
SourceVSwitchIdstringNo

The ID of the vSwitch.

  • When you query SNAT entries of Internet NAT gateways, this parameter specifies that Elastic Compute Service (ECS) instances in the vSwitch can use SNAT entries to access the Internet.
  • When you query SNAT entries of virtual private cloud (VPC) NAT gateways, this parameter specifies that ECS instances in the vSwitch can use SNAT entries to access external networks.
vsw-3xbjkhjshjdf****
SourceCIDRstringNo

The source CIDR block specified in the SNAT entry.

116.22.XX.XX/24
SnatIpstringNo
  • When you query SNAT entries of Internet NAT gateways, this parameter specifies the EIP in an SNAT entry.
  • When you query SNAT entries of VPC NAT gateways, this parameter specifies the NAT IP address in an SNAT entry.
116.22.XX.XX
SnatEntryNamestringNo

The name of the SNAT entry.

The name must be 2 to 128 characters in length, and can contain digits, underscores (_), and hyphens (-). The name must start with a letter.

SnatEntry-1
PageNumberintegerNo

The page number. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Maximum value: 50. Default value: 10.

10
NatGatewayIdstringNo

The ID of the NAT gateway.

Note You must specify at least one of SnatTableId and NatGatewayId.
ngw-bp1uewa15k4iy5770****

Response parameters

ParameterTypeDescriptionExample
object
PageSizeinteger

The number of entries per page.

5
RequestIdstring

The request ID.

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

The number of the returned page.

1
TotalCountinteger

The number of returned entries.

1
SnatTableEntriesobject []

Details of SNAT entries.

Statusstring

The status of the SNAT entry. Valid values:

  • Pending
  • Available
  • Deleting
Pending
SnatEntryNamestring

The name of the SNAT entry.

SnatEntry-1
SourceVSwitchIdstring
  • When you query SNAT entries of Internet NAT gateways, this parameter indicates the ID of the vSwitch that uses SNAT to access the Internet.
  • When you query SNAT entries of VPC NAT gateways, this parameter indicates the ID of the vSwitch that uses SNAT to access external networks.
vsw-3xbdsffvfgdfds****
SourceCIDRstring

The source CIDR block specified in the SNAT entry.

116.22.XX.XX/24
SnatEntryIdstring

The ID of the SNAT entry.

snat-kmd6nv8fy****
SnatTableIdstring

The ID of the SNAT table to which the SNAT entry belongs.

stb-gz3r3odawdgffde****
SnatIpstring
  • When you query SNAT entries of Internet NAT gateways, this parameter indicates the EIP in an SNAT entry.
  • When you query SNAT entries of VPC NAT gateways, this parameter indicates the NAT IP address in an SNAT entry.
116.22.XX.XX
NatGatewayIdstring

The ID of the NAT gateway to which the SNAT entry belongs.

ngw-bp1uewa15k4iy5770****

Examples

Sample success responses

JSONformat

{
  "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****"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidName.MalformedThe specified Name is not valid.The Name parameter is set to an invalid value.
400DESCRIBE_SNAT_PARAM_INVALIDSnatTableId and natGatewayId can not both be null-
404InvalidRegionId.NotFoundThe specified RegionId does not exist in our records.The specified region ID does not exist.
404InvalidSnatTableId.NotFoundSpecified SNAT table does not exist.The specified SNAT table does not exist.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-08-09The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 404
Output ParametersThe response structure of the API has changed.
2023-03-01The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 404