All Products
Search

This Product

    Cloud Firewall:DescribeVpcFirewallAssetList

    Document Center

    Cloud Firewall:DescribeVpcFirewallAssetList

    Last Updated:Jan 12, 2026

    Queries the assets protected by the VPC firewall.

    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 request and response.

    Valid values:

    • en :

      English

    • zh :

      Chinese

    zh
    Lang

    string

    No

    The language of the request and response.

    Valid values:

    • en :

      English

    • zh :

      Chinese

    zh
    StartTime

    string

    Yes

    The start time. The value is a UNIX timestamp. Unit: seconds.

    1534408189
    EndTime

    string

    Yes

    The end time. The value is a UNIX timestamp. Unit: seconds.

    1756952150
    VpcId

    string

    Yes

    The ID of the VPC instance.

    vpc-wz9ulqcvly23w31zkh8sm****
    PeerVpcId

    string

    No

    The ID of the peer VPC instance.

    vpc-90rq0anm6t8vbwbo****
    Port

    string

    No

    The port number.

    5234
    Direction

    string

    No

    The traffic direction.

    Valid values:

    • in :

      inbound

    • out :

      outbound

    in
    AppName

    string

    No

    The application name.

    test
    IPProtocol

    string

    No

    The protocol type.

    Valid values:

    • tcp :

      TCP

    • udp :

      UDP

    tcp
    RiskLevel

    string

    No

    The threat level.

    Valid values:

    • 0 :

      none

    • 1 :

      low

    • 2 :

      medium

    • 3 :

      high

    3
    EcsInstanceId

    string

    No

    The ID of the ECS instance.

    i-hp3ez3rs9bxwt034****
    EcsInstanceName

    string

    No

    The name of the asset instance.

    test-ecs
    AssetIP

    string

    No

    The IP address of the asset.

    192.0.XX.XX
    Sort

    string

    No

    The sorting method.

    Valid values:

    • InBytes :

      Sorts by inbound traffic.

    • SessionCount :

      Sorts by the number of sessions.

    • OutBytes :

      Sorts by outbound traffic.

    SessionCount
    Order

    string

    No

    The sort order.

    Valid values:

    • asc :

      ascending

    • desc :

      descending

    desc
    CurrentPage

    string

    No

    The page number.

    1
    PageSize

    string

    No

    The page number.

    10
    IsAITraffic

    string

    No

    Specifies whether to count only the traffic to AI services.

    true

    Response elements

    Element

    Type

    Description

    Example

    object

    TotalCount

    integer

    The total number of entries returned.

    30
    RequestId

    string

    The ID of the request.

    924A6CCC-4EAD-5554-8AD0-45F5ED56****
    DataList

    array<object>

    The data returned.

    object

    The data returned.

    RiskLevel

    integer

    The threat level.

    Valid values:

    • 0 :

      none

    • 1 :

      low

    • 2 :

      medium

    • 3 :

      high

    3
    SessionCount

    integer

    The total number of sessions.

    27
    AssetInstanceId

    string

    The ID of the asset instance.

    i-hp3ez3rs9bxwt034****
    OutBytes

    integer

    The outbound traffic. Unit: bytes.

    0.0
    RegionNo

    string

    The region.

    cn-beijing
    AssetIP

    string

    The IP address of the asset.

    192.0.XX.XX
    InBytes

    integer

    The inbound traffic. Unit: bytes.

    0.0
    AssetInstanceName

    string

    The name of the asset instance.

    ecs-test
    RiskReason

    string

    The reason for the threat.

    test
    PortList

    array

    The list of ports.

    string

    A list of ports.

    [ 80, 8080, 80, 21 ]
    TotalBytes

    integer

    The total traffic. Unit: bytes.

    0
    IpsHitCnt

    integer

    The number of intrusion prevention system (IPS) hits.

    10

    Examples

    Success response

    JSON format

    {
  "TotalCount": 30,
  "RequestId": "924A6CCC-4EAD-5554-8AD0-45F5ED56****",
  "DataList": [
    {
      "RiskLevel": 3,
      "SessionCount": 27,
      "AssetInstanceId": " i-hp3ez3rs9bxwt034****",
      "OutBytes": 0,
      "RegionNo": "cn-beijing",
      "AssetIP": "192.0.XX.XX",
      "InBytes": 0,
      "AssetInstanceName": "ecs-test",
      "RiskReason": "test",
      "PortList": [
        "[\n  80,\n  8080,\n  80,\n  21\n]"
      ],
      "TotalBytes": 0,
      "IpsHitCnt": 10
    }
  ]
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 ErrorAliUid Aliuid invalid. The aliuid is invalid.
    400 ErrorDBSelectError A database select error occurred. The error message returned because an internal error has occurred in querying the database.
    400 ErrorMarshalJSON internal error. Internal error.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.