All Products
Search
Document Center

Smart Access Gateway:DescribeSnatEntries

Last Updated:Mar 29, 2024

You can call this operation to query source network address translation (SNAT) entries associated with a Smart Access Gateway (SAG) instance.

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
smartag:DescribeSnatEntriesRead
  • SmartAccessGateway
    acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region where the SAG instance is deployed.

cn-hangzhou
SmartAGIdstringYes

The ID of the SAG instance.

sag-whfn************
PageNumberintegerNo

The number of the page to return. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page. Default value: 10. Maximum value: 50.

2

Response parameters

ParameterTypeDescriptionExample
object
PageSizeinteger

The number of entries returned per page.

5
RequestIdstring

The ID of the request.

674BC3B2-5828-41D5-830E-148EE6CF86C2
PageNumberinteger

The page number of the returned page.

12
TotalCountinteger

The total number of SNAT entries.

12
SnatEntriesobject []

The information about the SNAT entries.

InstanceIdstring

The ID of the SNAT entry.

snat-sl7kb9cpgfds*****
CidrBlockstring

The destination CIDR block.

192.169.10.0/24
CreateTimelong

The time when the SNAT entry was created.

1523604565000
SnatIpstring

The public IP address.

10.10.**.**

Examples

Sample success responses

JSONformat

{
  "PageSize": 5,
  "RequestId": "674BC3B2-5828-41D5-830E-148EE6CF86C2",
  "PageNumber": 12,
  "TotalCount": 12,
  "SnatEntries": {
    "SnatEntry": [
      {
        "InstanceId": "snat-sl7kb9cpgfds*****",
        "CidrBlock": "192.169.10.0/24",
        "CreateTime": 1523604565000,
        "SnatIp": "10.10.**.**"
      }
    ]
  }
}

Error codes

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