All Products
Search

This Product

    Cloud Firewall:DescribeAssetList

    Document Center

    Cloud Firewall:DescribeAssetList

    Last Updated:Oct 16, 2025

    Queries information about assets that are protected by Cloud Firewall.

    Operation description

    You can call this operation to query information about assets that are protected by Cloud Firewall. The query results are paginated.

    QPS limits

    The queries per second (QPS) limit for this operation is 10 per user. If the number of calls per second exceeds the limit, throttling is triggered. Throttling may affect your business. Plan your calls accordingly.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    Lang

    string

    No

    The language of the content within the response. Valid values:

    • zh (default): Chinese.

    • en: English.

    zh
    CurrentPage

    string

    Yes

    The number of the page to return.

    1
    PageSize

    string

    Yes

    The number of entries to return on each page.

    10
    RegionNo

    string

    No

    The region ID of the Cloud Firewall instance.

    Note

    For more information about the regions where Cloud Firewall is supported, see Supported regions.

    cn-hangzhou
    Status

    string

    No

    The status of the firewall. Valid values:

    • open: enabled.

    • opening: enabling.

    • closed: disabled.

    • closing: disabling.

    Note

    If you do not specify this parameter, assets that are in all states are queried.

    open
    SearchItem

    string

    No

    The IP address or instance ID of the asset.

    192.0.XX.XX
    Type

    string

    No

    This parameter is deprecated.

    eip
    ResourceType

    string

    No

    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: An EIP.

    • EniEIP: The EIP of an ENI.

    • NatEIP: The EIP of a NAT gateway.

    • SlbEIP: The EIP of an SLB instance (or a CLB instance).

    • SlbPublicIP: The public IP address of an SLB instance (or a CLB instance).

    • NatPublicIP: The public IP address of a NAT gateway.

    • HAVIP: An HAVIP.

    EIP
    SgStatus

    string

    No

    The status of the security group policy. Valid values:

    • pass: The policy is applied.

    • block: The policy is not applied.

    • unsupport: The policy is not supported.

    Note

    If you do not specify this parameter, assets with policies in all states are queried.

    pass
    IpVersion

    string

    No

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

    • 4 (default): IPv4.

    • 6: IPv6.

    4
    MemberUid

    integer

    No

    The UID of the member account.

    258039427902****
    UserType

    string

    No

    The type of the user. Valid values:

    • buy (default): paid.

    • free: free of charge.

    buy
    NewResourceTag

    string

    No

    The time when the asset was discovered. Valid values:

    • discovered in 1 hour: The asset was discovered within the last hour.

    • discovered in 1 day: The asset was discovered within the last 24 hours.

    • discovered in 7 days: The asset was discovered within the last 7 days.

    discovered in 1 hour
    OutStatistic

    string

    No

    Specifies whether to query information about outbound traffic.

    true
    SensitiveStatus

    string

    No

    The status of the data leakage prevention feature.

    open

    Response elements

    Element

    Type

    Description

    Example

    object

    TotalCount

    integer

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

    12
    RequestId

    string

    The ID of the request.

    CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D
    Assets

    array<object>

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

    object

    RiskLevel

    string

    The risk level of the asset. Valid values:

    • low: low.

    • middle: medium.

    • high: high.

    Note

    This parameter is returned only when `UserType` is set to `free`.

    low
    BindInstanceName

    string

    The name of the instance to which the asset is bound.

    instance01
    Type

    string

    This parameter is deprecated.

    eip
    SgStatusTime

    integer

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

    1615082937
    ResourceInstanceId

    string

    The instance ID of the asset.

    i-8vbdrjrxzt78****
    MemberUid

    integer

    The UID of the member account.

    258039427902****
    IntranetAddress

    string

    The private IP address of the server.

    192.168.XX.XX
    SyncStatus

    string

    Indicates whether traffic redirection is supported for the asset. Valid values:

    • enable: Traffic redirection is supported.

    • disable: Traffic redirection is not supported.

    enable
    AliUid

    integer

    The UID of the Alibaba Cloud account.

    Note

    This is the Alibaba Cloud account that is used to manage the member account.

    158039427902****
    ProtectStatus

    string

    The protection status of the asset. Valid values:

    • open: protected.

    • opening: enabling protection.

    • closed: unprotected.

    • closing: disabling protection.

    open
    InternetAddress

    string

    The public IP address of the server.

    192.0.XX.XX
    BindInstanceId

    string

    The ID of the instance to which the asset is bound.

    i-8vbdrjrxzt78****
    RegionID

    string

    The region ID of the asset.

    cn-hangzhou
    RegionStatus

    string

    Indicates whether Cloud Firewall can be enabled for the asset in the region. Valid values:

    • enable: yes.

    • disable: no.

    enable
    ResourceType

    string

    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: An 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: An HAVIP.

    EIP
    IpVersion

    integer

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

    Valid values:

    • 4: IPv4.

    • 6: IPv6.

    4
    SgStatus

    string

    The status of the security group policy. Valid values:

    • pass: The policy is applied.

    • block: The policy is not applied.

    • unsupport: The policy is not supported.

    block
    Note

    string

    The remarks on the asset. Valid values:

    • REGION_NOT_SUPPORT: The region is not supported.

    • NETWORK_NOT_SUPPORT: The network is not supported.

    REGION_NOT_SUPPORT
    Name

    string

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

    instance01
    CreateTimeStamp

    string

    The time when Cloud Firewall discovered the asset.

    2023-02-28 10:29:58
    NewResourceTag

    string

    The time when the asset was discovered. Valid values:

    • discovered in 1 hour: The asset was discovered within the last hour.

    • discovered in 1 day: The asset was discovered within the last 24 hours.

    • discovered in 7 days: The asset was discovered within the last 7 days.

    discovered in 1 hour
    SensitiveDataStatus

    string

    The status of the data leakage prevention feature.

    open
    Last7DayOutTrafficBytes

    integer

    The outbound traffic in the last 7 days.

    0

    Examples

    Success response

    JSON format

    {
  "TotalCount": 12,
  "RequestId": "CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D",
  "Assets": [
    {
      "RiskLevel": "low",
      "BindInstanceName": "instance01",
      "Type": "eip",
      "SgStatusTime": 1615082937,
      "ResourceInstanceId": "i-8vbdrjrxzt78****",
      "MemberUid": 0,
      "IntranetAddress": "192.168.XX.XX",
      "SyncStatus": "enable",
      "AliUid": 0,
      "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",
      "CreateTimeStamp": "2023-02-28 10:29:58",
      "NewResourceTag": "discovered in 1 hour",
      "SensitiveDataStatus": "open",
      "Last7DayOutTrafficBytes": 0
    }
  ]
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 ErrorDBSelect An error occurred while querying database. An error occurred while querying database.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.