All Products
Search

This Product

    Cloud Firewall:DescribeVpcFirewallAccessDetail

    Document Center

    Cloud Firewall:DescribeVpcFirewallAccessDetail

    Last Updated:Oct 15, 2025

    Queries the access details of a VPC firewall.

    Operation description

    QPS limits

    The queries per second (QPS) limit for this API is 10 for each user. If you exceed this limit, API calls are throttled, which can affect your business. We recommend that you call this API at a reasonable rate.

    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 response. Valid values:

    • zh (default): Chinese

    • en: English

    zh
    Lang

    string

    No

    The language of the response. Valid values:

    • zh (default): Chinese

    • en: English

    zh
    StartTime

    string

    Yes

    The start of the time range to query. This value is a UNIX timestamp that is accurate to the second.

    1655778046
    EndTime

    string

    Yes

    The end of the time range to query. This value is a UNIX timestamp that is accurate to the second.

    1729042555
    VpcId

    string

    Yes

    The ID of the VPC.

    vpc-2ze4xj5kmb5udb****
    Port

    string

    No

    The port number.

    80
    Direction

    string

    No

    The traffic direction. Valid values:

    • in: inbound

    • out: outbound

    Note

    If you do not specify this parameter, traffic in all directions is queried.

    in
    IPProtocol

    string

    No

    The protocol type. Valid values:

    • tcp: TCP

    • udp: UDP

    tcp
    RiskLevel

    string

    No

    The risk level.

    3
    PeerVpcId

    string

    No

    The ID of the peer VPC.

    vpc-90rq0anm6t8vbwbo****
    PeerAssetIP

    string

    No

    The IP address of the peer asset.

    10.125.1.XX
    PeerAssetInstanceId

    string

    No

    The instance ID of the peer asset.

    i-123451

    PeerAssetInstanceName

    string

    No

    The instance name of the peer asset.

    ecs22

    AssetIP

    string

    No

    The IP address of the local asset.

    192.0.XX.XX
    Sort

    string

    No

    The sorting criterion. Valid values are:

    • InBytes

    • OutBytes

    • TotalBytes

    • InPackets

    • OutPackets

    • SessionCount

    InBytes
    Order

    string

    No

    The sort order. Valid values:

    • asc: ascending

    • desc (default): descending

    desc
    CurrentPage

    string

    No

    The page number.

    1
    PageSize

    string

    No

    The number of entries per page.

    10

    Response elements

    Element

    Type

    Description

    Example

    object

    TotalCount

    integer

    The total number of entries.

    9
    RequestId

    string

    The ID of the request.

    8EAC2347-E85A-5DFF-9F49-B8E1BAFB****
    DataList

    array<object>

    The data entries.

    object

    A data entry.

    SessionCount

    integer

    The total number of sessions.

    27
    PeerAssetInstanceId

    string

    The instance ID of the peer asset.

    i-123451
    PeerAssetIP

    string

    The IP address of the peer asset.

    10.125.1.XX
    RegionNo

    string

    The ID of the region where the asset is located.

    cn-shenzhen
    OutBytes

    integer

    The number of sent bytes.

    1123
    InBytes

    integer

    The number of received bytes.

    17845821669.0
    peerVpcName

    string

    The name of the peer VPC.

    vpc-test
    PeerVpcId

    string

    The ID of the peer VPC.

    vpc-123411

    PeerAssetInstanceName

    string

    The instance name of the peer asset.

    test

    Examples

    Success response

    JSON format

    {
  "TotalCount": 9,
  "RequestId": "8EAC2347-E85A-5DFF-9F49-B8E1BAFB****",
  "DataList": [
    {
      "SessionCount": 27,
      "PeerAssetInstanceId": "i-123451",
      "PeerAssetIP": "10.125.1.XX",
      "RegionNo": "cn-shenzhen",
      "OutBytes": 1123,
      "InBytes": 17845821669,
      "peerVpcName": "vpc-test",
      "PeerVpcId": "vpc-123411\n",
      "PeerAssetInstanceName": "test"
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.