Display NAT Gateway Whitelist Resource List - DescribeWhiteListResource

Overview

Display NAT Gateway Whitelist Resource List

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `DescribeWhiteListResource`.	Yes
PublicKey	string	The user’s public key can be obtained from Console	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
ProjectId	string	Project ID	Yes
Region	string	Region. See List of Regions and Availability Zones	Yes
NATGWIds.N	string	Id of NAT Gateway	Yes
Offset	int	Data offset, default is 0	No
Limit	int	Data pagination value, default is 20	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[NatGWWhitelistDataSet]	Detailed information of the whitelist resources, see DescribeResourceWhiteListDataSet	Yes
TotalCount	int	Total number of the above DataSet	Yes

Data Model

NatGWWhitelistDataSet

Field Name	Type	Description Information	Required
NATGWId	string	NATGateWay Id	Yes
IfOpen	int	Whitelist Switch Tag	Yes
ObjectIPInfo	array[DescribeWhiteListResourceObjectIPInfo]	Whitelist Details	Yes

DescribeWhiteListResourceObjectIPInfo

Field Name	Type	Description Information	Required
GwType	string	natgw string	Yes
PrivateIP	string	Intranet IP of Whitelist Resources	Yes
ResourceId	string	Whitelist Resource Id Information	Yes
ResourceName	string	Whitelist Resource Name	Yes
ResourceType	string	Whitelist Resource Type	Yes
SubResourceId	string	Instance ID of the virtual network card bound to the resource	Yes
SubResourceName	string	The instance name of the virtual network card bound to the resource	Yes
SubResourceType	string	The type of virtual network card bound to the resource	Yes
VPCId	string	Whitelist Resource’s VPCId	No

Example

Request Example


https://api.surfercloud.com/?Action=DescribeWhiteListResource
&Region=cn-bj2
&NATGWIds.0=NbbRAeIJ
&ProjectId=KwzficzX
&Offset=5
&Limit=5

Response Example


{
  "Action": "DescribeWhiteListResourceResponse",
  "DataSet": [
    "nSRkanNq",
    "TkHTtQoc",
    "ONBPkxrr",
    "aoGskHfU",
    "suKalXHG",
    "UQMozDcj",
    "JVOeFxGX",
    "EUbVfeda"
  ],
  "RetCode": 0,
  "TotalCount": 9
}