Tencent Cloud

Recent Pages

Query Peer IP Translation

Last updated: 2020-06-04 18:33:09

Note：
This is a legacy API which has been hidden and will no longer be updated. We recommend using the new VPC API 3.0 which is standardized and faster.

1. API Description

This API (DescribePeerIPTranslationNatRule) is used to query the peer IP translation rules for Direct Connect gateway.
Domain for API request:vpc.api.qcloud.com

This API is used to query the peer IP translation rules for the specified Direct Connect gateway.

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 DescribePeerIPTranslationNatRule.

Parameter Name	Required	Type	Description
vpcId	Yes	String	Virtual private cloud ID assigned by the system, for example: vpc-dfg5445.
directConnectGatewayId	Yes	String	Direct Connect gateway ID assigned by the system, for example: dcg-4d545d.
originalIP	No	String	Original IP.
translationIP	No	String	Translated IP.
description	No	String	Note. Fuzzy search is supported.
offset	No	Int	Offset of initial line. Default is 0.
limit	No	Int	Number of lines per page. Default is 20.

3. Output Parameters

Parameter Name	Type	Description
code	Int	Common error code. A value of 0 indicates success, and other values indicate failure. For more information, please refer to Common Error Codes on the Error Code page.
message	String	Module error message description depending on API.
data.n	Array	Local IP translation rule information array.
data.n.originalIP	String	Original IP.
data.n.translationIP	String	Translated IP.
data.n.description	String	Note.

4. Error Code Table

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 the resource information you entered is correct. This can be queried via the Query Virtual Private Cloud List (DescribeVpcEx) API.
InvalidDirectConnectGateway.NotFound	Invalid Direct Connect gateway. Direct Connect gateway resource does not exist. Please verify that the resource information you entered is correct. This can be queried via the Query Direct Connect Gateway (DescribeDirectConnectGateway) API.
InvalidPeerIPTranslation.NotFound	Invalid peer IP translation rules. Peer IP translation rule does not exist. Please verify that the resource information you entered is correct. This can be queried via the Query Peer IP Translation for Direct Connect Gateway (DescribePeerIPTranslationNatRule) API.
InvalidOriginalIP.Duplicate	Invalid original IP. Duplication of original IP. The original IP has already existed in the local IP Direct Connect rules of the gateway. The original IP must be unique.

5. Example

Input

https://vpc.api.qcloud.com/v2/index.php?Action=DescribePeerIPTranslationNatRule
&>
&vpcId=vpc-dfgg190
&directConnectGatewayId=dcg-ddf14d

Output

{
    "code":"0",
    "message":"",
    "data": [
        {
            "originalIP": "10.0.0.1",
            "translationIP": "138.0.0.1",
            "description": "Note 1"
        }
    ]
}