Private Network(UVPC)

Display NAT Gateway Whitelist Resource List - DescribeWhiteListResource


Display NAT Gateway Whitelist Resource List


Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is DescribeWhiteListResource.Yes
PublicKeystringThe user's public key can be obtained from Console (opens in a new tab)Yes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
ProjectIdstringProject IDYes
RegionstringRegion. See List of Regions and Availability ZonesYes
NATGWIds.NstringId of NAT GatewayYes
OffsetintData offset, default is 0No
LimitintData pagination value, default is 20No

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
DataSetarray[NatGWWhitelistDataSet]Detailed information of the whitelist resources, see DescribeResourceWhiteListDataSetYes
TotalCountintTotal number of the above DataSetYes

Data Model


Field NameTypeDescription InformationRequired
NATGWIdstringNATGateWay IdYes
IfOpenintWhitelist Switch TagYes
ObjectIPInfoarray[DescribeWhiteListResourceObjectIPInfo]Whitelist DetailsYes


Field NameTypeDescription InformationRequired
GwTypestringnatgw stringYes
PrivateIPstringIntranet IP of Whitelist ResourcesYes
ResourceIdstringWhitelist Resource Id InformationYes
ResourceNamestringWhitelist Resource NameYes
ResourceTypestringWhitelist Resource TypeYes
SubResourceIdstringInstance ID of the virtual network card bound to the resourceYes
SubResourceNamestringThe instance name of the virtual network card bound to the resourceYes
SubResourceTypestringThe type of virtual network card bound to the resourceYes
VPCIdstringWhitelist Resource's VPCIdNo


Request Example

Response Example

  "Action": "DescribeWhiteListResourceResponse",
  "DataSet": [
  "RetCode": 0,
  "TotalCount": 9
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved
  • Contact our sales to help your business.
  • Contact our sales to help your business.