1. API Description
This API (DescribeLocalSourceIPPortTranslationNatRule) is used to query the local source IP port translation rules for Direct Connect gateway.
Domain for API request:vpc.api.qcloud.com
This API is used to query the local source IP port 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 DescribeLocalSourceIPPortTranslationNatRule.
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. |
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; 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. |
data.n | Array | Local IP translation rule information array. |
data.n.translationIPPool | String | Mapped IP pool. |
data.n.description | String | Note. |
4. Error Code Table
The following 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. |
InvalidTranslationIPPool.NotFound | Invalid translated IP pool. Translated IP pool does not exist. Please verify that the resource information you entered is correct. This can be queried via the Query Local Source IP Port Translation for Direct Connect gateway(DescribeLocalSourceIPPortTranslationNatRule) API. |
5. Example
Input
https://vpc.api.qcloud.com/v2/index.php?Action=DescribeLocalSourceIPPortTranslationNatRule &<Common request parameters> &vpcId=vpc-dfgg190 &directConnectGatewayId=dcg-ddf14d
Output
{
"code":"0",
"message":"",
"data": [
{
"translationIPPool": "1.1.1.1-1.1.2.254",
"description": "Note 1"
}
]
}