Obtain resources that can add whitelist to the NAT gateway - GetAvailableResourceForWhiteList

Overview

Obtain resources that can add whitelist to the NAT gateway

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `GetAvailableResourceForWhiteList`.	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 fill in. Please refer to the GetProjectList interface.	No
NATGWId	string	NAT Gateway Id	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[GetAvailableResourceForWhiteListDataSet]	Return detailed information of the whitelist list	Yes
TotalCount	int	Total number of resources in the whitelist	Yes

Data Model

GetAvailableResourceForWhiteListDataSet

Field Name	Type	Description Information	Required
ResourceId	string	Resource Type Id	Yes
ResourceName	string	Resource Name	Yes
PrivateIP	string	Intranet IP of the resource	Yes
ResourceType	string	Resource Type. "uhost": UHost; "upm", Physical Cloud Host; "hadoophost": Hadoop Node; "fortresshost": Bastion Host; "udockhost", Container.	Yes
SubResourceName	string	The instance name of the virtual network card bound to the resource	Yes
VPCId	string	Resource Belonging VPCId	Yes
SubnetworkId	string	Subnet Id of the resource	Yes
SubResourceId	string	Instance ID of the virtual network card bound to the resource	No
SubResourceType	string	Instance type of the virtual network card bound to the resource	No

Example

Request Example

https://api.ucloud-global.com/?Action=GetAvailableResourceForWhiteList
&Region=xxx
&ProjectId=xxx
&NATGWId=CuqLxGDE
&Offset=7
&Limit=8

Response Example

{
  "Action": "GetAvailableResourceForWhiteListResponse",
  "DataSet": [
    {
      "PrivateIP": "xxxx",
      "ResourceId": "xxxx",
      "ResourceType": "xxxx"
    }
  ],
  "RetCode": 0,
  "TotalCount": 1
}

GetAvailableResourceForSnatRule GetNetworkAclTargetResource