Basic Network(UNet)

Get Firewall Bound Resources - DescribeFirewallResource


Get the public IP of the resource bound to the firewall group


Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is DescribeFirewallResource.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
RegionstringRegion. See List of Regions and Availability ZonesYes
ProjectIdstringProject ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.No
FWIdstringFirewall IDYes
LimitintReturn data length, default is 20, maximum 1000No
OffsetintList start position offset, default is 0No

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
ResourceSetarray[ResourceSet]Resource List, see ResourceSetNo
TotalCountintTotal Number of Bound ResourcesNo

Data Model


Field NameTypeDescription InformationRequired
ZoneintAvailability ZoneNo
SubResourceNamestringThe name of the virtual network card bound to the resourceYes
SubResourceIdstringID of the virtual network card bound to the resourceYes
SubResourceTypestringThe type of the virtual network card bound to the resource, 'uni', virtual network card.Yes
PrivateIPstringPrivate IPNo
ResourceIDstringResource ID bound to this firewallNo
ResourceTypestringResource types for binding firewall groups. "unatgw", NAT Gateway; "uhost", Cloud Host; "upm", Physical Cloud Host; "hadoophost", Hadoop Node; "fortresshost", Bastion Host; "udhost", Private Zone Host; "udockhost", Container; "dbaudit", Database Audit; "uni", Virtual Network Interface.No
TagstringBusiness GroupNo


Request Example

Response Example

  "Action": "DescribeFirewallResourceResponse",
  "ResourceSet": [
      "Name": "hc_host",
      "PrivateIP": "10.23.XX.XX",
      "Remark": "",
      "ResourceID": "uhost-XXXXXX",
      "ResourceType": "uhost",
      "Status": 1,
      "Tag": "Default",
      "Zone": 8200
  "RetCode": 0,
  "TotalCount": 6
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved
  • Contact our sales to help your business.
  • Contact our sales to help your business.