Domain name for API request: vpc.tencentcloudapi.com.
This API is used to query the NAT gateway's SNAT forwarding rules.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: DescribeNatGatewaySourceIpTranslationNatRules. |
Version | Yes | String | Common Params. The value used for this API: 2017-03-12. |
Region | No | String | Common Params. This parameter is not required for this API. |
NatGatewayId | Yes | String | The unique ID of the NAT Gateway, such as nat-123xx454 . |
Filters.N | No | Array of Filter | Filter:resource-id : The subnet ID (such as subnet-0yi4hekt ) or CVM IDpublic-ip-address : The EIP, such as 139.199.232.238 description The rule description |
Offset | No | Integer | Offset. Default value: 0. |
Limit | No | Integer | Number of returned results. Default value: 20. Maximum value: 100. |
Parameter Name | Type | Description |
---|---|---|
SourceIpTranslationNatRuleSet | Array of SourceIpTranslationNatRule | Array of objects of a NAT gateway's SNAT rules. Note: this field may return null , indicating that no valid values can be obtained. |
TotalCount | Integer | The number of eligible object arrays of a NAT gateway's forwarding rules. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to use the Filter array to obtain the SNAT forwarding rules of a NAT gateway.
https://vpc.tencentcloudapi.com/?Action=DescribeNatGatewaySourceIpTranslationNatRules
&NatGatewayId=nat-3isn9hr0
&Filters.0.Name=resource-id
&Filters.0.Values.0=subnet-0yi4hekt
&<Common request parameters>
{
"Response": {
"TotalCount": 1,
"SourceIpTranslationNatRuleSet": [
{
"NatGatewaySnatId": "subnet-0yi4hekt",
"ResourceId": "subnet-0yi4hekt",
"ResourceType": "SUBNET",
"PublicIpAddresses": [
"139.199.232.238"
],
"PrivateIpAddress": "10.80.80.0/24",
"Description": "test_snat",
"CreatedTime": "2019-05-04 13:42:11",
"NatGatewayId": "nat-3isn9hr0",
"VpcId": "vpc-0yi4hekt"
}
],
"RequestId": "eb203971-a7a0-45c1-9c72-36ad86688590"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
InternalError | An internal error occurred. |
InternalServerError | Internal error. |
InvalidAddressId.NotFound | The specified EIP does not exist. |
InvalidParameter | A parameter error occurred. |
InvalidParameter.FilterInvalidKey | The specified filter condition does not exist. |
InvalidParameterValue | Incorrect parameter value. |
InvalidParameterValue.LimitExceeded | The parameter value exceeds the limit. |
InvalidParameterValue.Malformed | Invalid input parameter format. |
InvalidParameterValue.Range | The parameter value is not in the specified range. |
ResourceNotFound | The resource does not exist. |
Was this page helpful?