tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateNatGatewaySourceIpTranslationNatRule

Last updated: 2023-08-23 14:11:28

1. API Description

Domain name for API request: vpc.tencentcloudapi.com.

This API is used to create SNAT rules for a NAT gateway.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: CreateNatGatewaySourceIpTranslationNatRule.
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 ID of the NAT Gateway, such as nat-df45454
SourceIpTranslationNatRules.N Yes Array of SourceIpTranslationNatRule The SNAT forwarding rule of the NAT Gateway

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating an SNAT rule for the NAT gateway

Input Example

https://vpc.tencentcloudapi.com/?Action=CreateNatGatewaySourceIpTranslationNatRule
&NatGatewayId=nat-3isn9hr0
&SourceIpTranslationNatRules.0.ResourceId=cvm-24796297
&SourceIpTranslationNatRules.0.ResourceType=NETWORKINTERFACE
&SourceIpTranslationNatRules.0.PrivateIpAddress=10.80.80.41
&SourceIpTranslationNatRules.0.PublicIpAddresses.0=180.12.59.43
&SourceIpTranslationNatRules.0.Description=test_snat
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "14f7ea4e-8452-4742-84b5-5a4aee304968"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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.
InvalidParameter A parameter error occurred.
InvalidParameterValue Incorrect parameter value.
InvalidParameterValue.Malformed Invalid input parameter format.
InvalidParameterValue.NatSnatRuleExists The NAT Gateway already has an identical SNAT rule.
LimitExceeded Quota limit is reached.
ResourceNotFound The resource does not exist.
UnknownParameter Unknown parameter error.
UnsupportedOperation.NatGatewayEipNotExists The public IP of the NAT gateway does not exist.
UnsupportedOperation.NatGatewayRulePipExists The private IP specified in the SNAT/DNAT forwarding rule has been bound with another rule.
UnsupportedOperation.NatGatewaySnatPipNeedVm The private IP of the SNAT translation rule must be within the IP range of the VM ENI.
UnsupportedOperation.NatGatewayTypeNotSupportSNAT The specified NAT Gateway type does not support configuring a SNAT rule.
UnsupportedOperation.UnbindEIP EIP is not bound.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy