Queries the assets that are protected by Cloud Firewall.

Description

You can call the DescribeAssetList operation to query the assets that are protected by Cloud Firewall.

Limits

You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

Debugging

Alibaba Cloud provides OpenAPI Explorer to simplify API usage. OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeAssetList

The operation that you want to perform. Set the value to DescribeAssetList.

SourceIp String No 192.0.XX.XX

The source IP address of the request.

Lang String No zh

The natural language of the request and response. Valid values:

  • zh: Chinese (default)
  • en: English
CurrentPage String Yes 1

The number of the page to return.

PageSize String Yes 10

The number of entries to return on each page. Maximum value: 50.

RegionNo String No cn-hangzhou

The ID of the region in which Cloud Firewall is available.

Note For more information, see Supported regions.
Status String No open

The status of the firewall. Valid values:

  • open: The firewall is enabled.
  • opening: The firewall is being enabled.
  • closed: The firewall is disabled.
  • closing: The firewall is being disabled.
Note If you do not specify this parameter, the assets that are configured for firewalls in all states are queried.
SearchItem String No 192.0.XX.XX

The instance ID or the IP address of the asset.

Type String No eip

This parameter is deprecated.

ResourceType String No EIP

The type of the asset. Valid values:

  • BastionHostEgressIP: the egress IP address of a bastion host
  • BastionHostIngressIP: the ingress IP address of a bastion host
  • EcsEIP: the elastic IP address (EIP) of an Elastic Compute Service (ECS) instance
  • EcsPublicIP: the public IP address of an ECS instance
  • EIP: the EIP
  • EniEIP: the EIP of an elastic network interface (ENI)
  • NatEIP: the EIP of a Network Address Translation (NAT) gateway
  • SlbEIP: the EIP of a Server Load Balancer (SLB) instance
  • SlbPublicIP: the public IP address of an SLB instance
  • NatPublicIP: the public IP address of a NAT gateway
  • HAVIP: the high-availability virtual IP address (HAVIP)
SgStatus String No pass

The status of the security group policy. Valid values:

  • pass: delivered
  • block: undelivered
  • unsupport: unsupported
    Note If you do not specify this parameter, the assets on which security group policies in all states take effect are queried.
IpVersion String No 4

The IP version of the asset that is protected by Cloud Firewall. Valid values:

  • 4: IPv4 (default)
  • 6: IPv6
MemberUid Long No 258039427902****

The UID of the member that is added to Cloud Firewall.

UserType String No buy

The edition of Cloud Firewall. Valid values:

  • buy: a paid edition (default)
  • free: a free edition

Response parameters

Parameter Type Example Description
TotalCount Integer 12

The total number of the assets that are protected by Cloud Firewall.

RequestId String CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D

The ID of the request.

Assets Array of Resource

The details about the assets that are protected by Cloud Firewall.

RiskLevel String low

The risk level of the asset. Valid values:

  • low: low
  • middle: medium
  • hight: high
Note The value of this parameter is returned only when the UserType parameter is set to free.
BindInstanceName String instance01

The name of the asset that is bound to Cloud Firewall.

Type String eip

This parameter is deprecated.

SgStatusTime Long 1615082937

The timestamp when the status of the security group was last checked. The value is a UNIX timestamp. Unit: seconds.

ResourceInstanceId String i-8vbdrjrxzt78****

The ID of the asset.

MemberUid Long 258039427902****

The UID of the member that is added to Cloud Firewall.

IntranetAddress String 192.168.XX.XX

The internal IP address of the server.

SyncStatus String enable

The status of traffic redirection for the asset. Valid values:

  • enable: Traffic redirection is supported.
  • disable: Traffic redirection is not supported.
AliUid Long 158039427902****

The UID of the Alibaba Cloud account.

ProtectStatus String open

The status of the firewall. Valid values:

  • open: The firewall is enabled.
  • opening: The firewall is being enabled.
  • closed: The firewall is disabled.
  • closing: The firewall is being disabled.
InternetAddress String 192.0.XX.XX

The public IP address of the server.

BindInstanceId String i-8vbdrjrxzt78****

The instance ID of the asset that is bound to Cloud Firewall.

RegionID String cn-hangzhou

The ID of the region in which the asset resides.

RegionStatus String enable

Indicates whether the firewall is supported in the region in which the asset resides. Valid values:

  • enable: supported
  • disable: unsupported
ResourceType String EIP

The type of the asset. Valid values:

  • BastionHostEgressIP: the egress IP address of a bastion host
  • BastionHostIngressIP: the ingress IP address of a bastion host
  • EcsEIP: the EIP of an ECS instance
  • EcsPublicIP: the public IP address of an ECS instance
  • EIP: the EIP
  • EniEIP: the EIP of an ENI
  • NatEIP: the EIP of a NAT gateway
  • SlbEIP: the EIP of an SLB instance
  • SlbPublicIP: the public IP address of an SLB instance
  • NatPublicIP: the public IP address of a NAT gateway
  • HAVIP: the HAVIP
IpVersion Integer 4

The IP version of the asset that is protected by Cloud Firewall.

Valid values:

  • 4: IPv4
  • 6: IPv6
SgStatus String block

The status of the security group policy. Valid values:

  • pass: delivered
  • block: undelivered
  • unsupport: unsupported
Note String REGION_NOT_SUPPORT

The remarks of the asset. Valid values:

  • REGION_NOT_SUPPORT: The region is not supported.
  • NETWORK_NOT_SUPPORT: The network is not supported.
Name String instance01

The instance name of the asset that is protected by Cloud Firewall.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeAssetList
&SourceIp=192.0.XX.XX
&Lang=zh
&CurrentPage=1
&PageSize=10
&RegionNo=cn-hangzhou
&Status=open
&SearchItem=192.0.XX.XX
&Type=eip
&ResourceType=EIP
&SgStatus=pass
&IpVersion=4
&UserType=buy
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeAssetListResponse>
    <TotalCount>12</TotalCount>
    <RequestId>CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D</RequestId>
    <Assets>
        <RiskLevel>low</RiskLevel>
        <BindInstanceName>instance01</BindInstanceName>
        <Type>eip</Type>
        <SgStatusTime>1615082937</SgStatusTime>
        <ResourceInstanceId>i-8vbdrjrxzt78****</ResourceInstanceId>
        <IntranetAddress>192.168.XX.XX</IntranetAddress>
        <SyncStatus>enable</SyncStatus>
        <ProtectStatus>open</ProtectStatus>
        <InternetAddress>192.0.XX.XX</InternetAddress>
        <BindInstanceId>i-8vbdrjrxzt78****</BindInstanceId>
        <RegionID>cn-hangzhou</RegionID>
        <RegionStatus>enable</RegionStatus>
        <ResourceType>EIP</ResourceType>
        <IpVersion>4</IpVersion>
        <SgStatus>block</SgStatus>
        <Note>REGION_NOT_SUPPORT</Note>
        <Name>instance01</Name>
    </Assets>
</DescribeAssetListResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 12,
  "RequestId" : "CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D",
  "Assets" : [ {
    "RiskLevel" : "low",
    "BindInstanceName" : "instance01",
    "Type" : "eip",
    "SgStatusTime" : 1615082937,
    "ResourceInstanceId" : "i-8vbdrjrxzt78****",
    "IntranetAddress" : "192.168.XX.XX",
    "SyncStatus" : "enable",
    "ProtectStatus" : "open",
    "InternetAddress" : "192.0.XX.XX",
    "BindInstanceId" : "i-8vbdrjrxzt78****",
    "RegionID" : "cn-hangzhou",
    "RegionStatus" : "enable",
    "ResourceType" : "EIP",
    "IpVersion" : 4,
    "SgStatus" : "block",
    "Note" : "REGION_NOT_SUPPORT",
    "Name" : "instance01"
  } ]
}