CreateNatGatewayDestinationIpPortTranslationNatRule

Download PDF

CreateNatGatewayDestinationIpPortTranslationNatRule

最后更新时间：2023-08-23 14:11:28

下载PDF

1. API Description

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

This API is used to create the port forwarding rules of a NAT gateway.

A maximum of 100 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: CreateNatGatewayDestinationIpPortTranslationNatRule.
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`.
DestinationIpPortTranslationNatRules.N	Yes	Array of DestinationIpPortTranslationNatRule	The port forwarding rules 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 NAT forwarding rules

Input Example

https://vpc.tencentcloudapi.com/?Action=CreateNatGatewayDestinationIpPortTranslationNatRule
&NatGatewayId=nat-3isn9hr0
&DestinationIpPortTranslationNatRules.0.IpProtocol=TCP
&DestinationIpPortTranslationNatRules.0.PublicIpAddress=139.199.232.238
&DestinationIpPortTranslationNatRules.0.PublicPort=8989
&DestinationIpPortTranslationNatRules.0.PrivateIpAddress=10.80.80.41
&DestinationIpPortTranslationNatRules.0.PrivatePort=8989
&DestinationIpPortTranslationNatRules.0.Description=test_dnapt
&<Common request parameters>

Output Example

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

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

Tencent Cloud CLI 3.0

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
InvalidParameterValue.LimitExceeded	The parameter value exceeds the limit.
InvalidParameterValue.NatGatewayDnatRuleExisted	The DNAT forwarding rule of the NAT gateway already exists.
InvalidParameterValue.NatGatewayDnatRulePipNeedVm	The private IP of the DNAT translation rule must be an IP used by the ENI of the virtual machine.
InvalidParameterValue.NatGatewayDnatRuleRepeated	The DNAT rule of the NAT gateway to add already exists.
InvalidParameterValue.TooLong	Invalid parameter value. The parameter value is too long.
LimitExceeded	Quota limit is reached.
ResourceNotFound	The resource does not exist.
UnsupportedOperation.NatGatewayEipNotExists	The public IP of the NAT gateway does not exist.

tencent cloud

Recent Pages

CreateNatGatewayDestinationIpPortTranslationNatRule

1. API Description

2. Input Parameters

3. Output Parameters