Obtain resource information for configurable port forwarding rules of NAT gateway - GetAvailableResourceForPolicy

Overview

Obtain resource information for configurable port forwarding rules of NAT gateway

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `GetAvailableResourceForPolicy`.	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
Limit	int	Return data length, default is 20	No
Offset	int	List start position offset, default is 0	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[GetAvailableResourceForPolicyDataSet]	Information on supported resource types	Yes

Data Model

GetAvailableResourceForPolicyDataSet

Field Name	Type	Description Information	Required
ResourceId	string	Resource's Id	Yes
PrivateIP	string	Intranet IP corresponding to the resource	Yes
ResourceType	string	Resource Type. "uhost": UHost; "upm", Physical Cloud Host; "hadoophost": Hadoop Node; "fortresshost": Bastion Host; "udockhost", Container.	Yes

Example

Request Example

https://api.surfercloud.com/?Action=GetAvailableResourceForPolicy
&Region=xxx
&ProjectId=xxx
&NATGWId=CuqLxGDE
&Limit=1000
&Offset=0

Response Example

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

EnableWhiteList GetAvailableResourceForSnatRule