Add Local Target IP Port Translation

Last updated: 2017-12-05 17:11:47

PDF

1. API Description

This API (CreateLocalDestinationIPPortTranslationNatRule) is used to add local destination IP port translation for Direct Connect gateway.
Domain for API request:vpc.api.qcloud.com
1) The Direct Connect peer accesses the VPC actively and needs to access the mapped IP port in order to communicate with the original IP within the VPC. Response packets are not affected. Only NAT Direct Connect gateways are supported.

2. Input Parameters

The following request parameter list only provides API request parameters. Common request parameters need to be added when the API is called. For more information, refer to Common Request Parameters. The Action field for this API is CreateLocalDestinationIPPortTranslationNatRule.

Parameter Name Required Type Description
vpcId Yes String Virtual private cloud ID or unified ID (unified ID is recommended).
directConnectGatewayId Yes String Direct Connect gateway ID.
localDestinationIPPortTranslation.n Yes Array Array of local destination IP port translation rules.
localDestinationIPPortTranslation.n.originalIP Yes String Original IP.
localDestinationIPPortTranslation.n.originalPort Yes String Original port.
localDestinationIPPortTranslation.n.translationIP Yes String Translated IP.
localDestinationIPPortTranslation.n.translationPort Yes String Translated port.
localDestinationIPPortTranslation.n.proto Yes String Protocol.
localDestinationIPPortTranslation.n.description No String Note.

3. Output Parameters

Parameter Name Type Description
code Int Common error code; 0: Succeeded; other values: Failed. For more information, please refer to Common Error Codes on the Error Code page.
message String Module error message description depending on API.
codeDesc String Error code
data Array Returned information

4. Error Code List

The following error code list only provides the business logic error codes for this API. For additional common error codes, refer to VPC Error Codes.

Error Code Description
InvalidVpc.NotFound Invalid VPC. VPC resource does not exist. Please verify that you have entered resource information correctly. This can be queried via the Querying Virtual Private Cloud List (DescribeVpcEx) API.
InvalidDirectConnectGateway.NotFound Invalid Direct Connect gateway. The Direct Connect gateway does not exist. Please verify that you have entered resource information correctly. This can be queried via the Querying Direct Connect Gateway (DescribeDirectConnectGateway) API.
InvalidOriginalIP.NotInVpcCidr Invalid original IP. The original IP is not in the VPC network segment.
InvalidTranslationIP.InVpcCidr Invalid translated IP. The translated IP is in the VPC network segment.
InvalidTranslationIP.Duplicate Invalid translated IP. Duplication of translated IP. The translated IP has already existed in the local IP Direct Connect rules of the gateway. Duplication of translated IP is not allowed.
LocalDestinationIPPortTranslationLimitExceeded The local destination IP port translation rules you added have reached the upper limit. Please contact customer service for more resources. For more information on VPC resource restrictions, refer to VPC Usage Restrictions.

5. Example

Input


https://vpc.api.qcloud.com/v2/index.php?Action=CreateLocalDestinationIPPortTranslationNatRule
&<Common request parameters>
&vpcId=vpc-csnmo39l
&directConnectGatewayId=dcg-mm01ughx
&localDestinationIPPortTranslation.0.originalIP=10.100.10.3
&localDestinationIPPortTranslation.0.originalPort=80
&localDestinationIPPortTranslation.0.translationIP=183.0.0.1
&localDestinationIPPortTranslation.0.translationPort=90
&localDestinationIPPortTranslation.0.proto=tcp
&localDestinationIPPortTranslation.0.description=183.0.0.1

Output

{
    "code":"0",
    "message":"",
    "codeDesc":"Success",
    "data":[

    ]
}