Obtain the information of the internal and external IP mapping rules created based on NAT - DescribeSnatDnatRule

Overview

Obtain the information of the internal and external IP mapping rules created based on NAT

💡 Only one parameter is allowed to have a value at the same time for PrivateIp and NATGW.

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `DescribeSnatDnatRule`.	Yes
PublicKey	string	The user's public key can be obtained from Console (opens in a new tab)	Yes
Signature	string	User signature generated based on public key and API command, see Signature Algorithm	Yes

Request Parameters

Parameter Name	Type	Description Information	Required
Region	string	Region. See List of Regions and Availability Zones	Yes
ProjectId	string	Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.	No
NATGWId.N	string	Retrieve all SnatDnatRule information added on NAT	No
EIP.N	string	Get the SnatDnatRule information corresponding to EIP	No

Response Field

Field Name	Type	Description Information	Required
RetCode	int	Return status code. If it is 0, it means successful return. If it is not 0, it means failure.	Yes
Action	string	Operation command name.	Yes
Message	string	Returns an error message, providing detailed description when `RetCode` is non-zero.	No
DataSet	array[SnatDnatRuleInfo]	Rule Information	No

Data Model

SnatDnatRuleInfo

Field Name	Type	Description Information	Required
PrivateIp	string	Private IP Address	No
NATGWId	string	The NAT Gateway resource ID used for mapping	No
EIP	string	EIP's IP address	No

Example

Request Example

https://api.ucloud-global.com/?Action=DescribeSnatDnatRule
&Region=cn-zj
&ProjectId=QRbWkHUb
&NATGWId=cDLnarQV
&Offset=kbFtTKlH
&Limit=GMKqQMhV
&PrivateIp.n=NbnLFMsf
&EIPAddr.n=eWlihxoN
&RuleId.n=kHylfauB
&PrivateIp.n=hpZCJtGP
&EIPAddr.n=zQgqwHES
&RuleId.n=mXPVWbPY

Response Example

{
  "Action": "DescribeSnatDnatRuleResponse",
  "NATGWMapInfos": "qIQkNLMg",
  "RetCode": 0
}

DescribeSecondaryIp DescribeSnatRule