Display Subnet Resources - DescribeSubnetResource

Overview

Display Subnet Resources

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `DescribeSubnetResource`.	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, and the sub-account must be filled in. Please refer to the GetProjectList interface.	No
SubnetId	string	Subnet ID	Yes
ResourceType	string	Resource type, default is all resource types. Enumerated values are: UHOST, Cloud Host; PHOST, Physical Cloud Host; ULB, Load Balancer; UHADOOP_HOST, hadoop node; UFORTRESS_HOST, Bastion Host; UNATGW, NAT Gateway; UKAFKA, Kafka Message Queue; UMEM, Memory Storage; DOCKER, Container Cluster; UDB, Database; UDW, Data Warehouse; VIP, Internal Network VIP.	No
Offset	int	List start position offset, default is 0	No
Limit	int	Length of data returned per page, 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
TotalCount	int	Total	No
DataSet	array[SubnetResource]	Return data set, see SubnetResource	No

Data Model

SubnetResource

Field Name	Type	Description Information	Required
Name	string	Name	No
ResourceId	string	Resource Id	No
ResourceType	string	Resource type. Corresponding resource types: UHOST, Cloud Host; PHOST, Physical Cloud Host; ULB, Load Balancer; UHADOOP_HOST, Hadoop Node; UFORTRESS_HOST, Bastion Host; UNATGW, NAT Gateway; UKAFKA, Distributed Messaging System; UMEM, Memory Storage; DOCKER, Container Cluster; UDB, Database; UDW, Data Warehouse; VIP, Intranet VIP.	No
IP	string	Resource IP	No

Example

Request Example

https://api.surfercloud.com/?Action=DescribeSubnetResource
&Region=cn-sh2
&ProjectId=org-XXXX
&SubnetId=subnet-XXXXX
&ResourceType=VIP
&Offset=1
&Limit=5

Response Example

{
  "Action": "DescribeSubnetResourceResponse",
  "DataSet": [
    {
      "IP": "10.23.XX.25",
      "Name": "VIP",
      "ResourceId": "vip-XXXX",
      "ResourceType": "VIP"
    }
  ],
  "RetCode": 0,
  "TotalCount": 1
}

DescribeSubnet DescribeVIP