All Products
Search
Document Center

Cloud Firewall:DescribeVpcFirewallDomainList

Last Updated:Jan 08, 2026

Queries a list of domain names accessed through a VPC firewall.

Operation description

The queries per second (QPS) limit for this operation is 10 calls per second for each user. If you exceed this limit, API calls are throttled. Throttling can affect your business. Call this operation 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: Chinese. This is the default value.

  • en: English

zh

StartTime

string

Yes

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

1656664560

EndTime

string

Yes

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

1656750960

PageSize

string

No

The number of entries to return on each page.

10

CurrentPage

string

No

The current page number.

1

Domain

string

No

The domain name. This parameter supports only term queries.

www.example.com

SrcIP

string

No

The source IP address that is used to access the domain name.

47.92.x.x

Sort

string

No

The sorting order. Valid values: asc (ascending) and desc (descending).

desc

Order

string

No

The field to sort by.

Default value: TotalBytes.

Valid values:

TotalBytes: Sorts the results by total traffic.

SessionCount: Sorts the results by the number of sessions.

SessionCount

SrcVpcId

string

No

The ID of the source VPC.

vpc-t4nlt09olhpazpoeg****

IsAITraffic

string

No

Specifies whether to count only the traffic generated by accessing AI services. The default value is false. Valid values:

  • true: Yes

  • false: No

true

Response elements

Element

Type

Description

Example

object

TotalCount

integer

The total number of entries returned.

132

RequestId

string

The ID of the request.

133173B9-8010-5DF5-8B93-********

DataList

array<object>

The list of returned data.

object

The array of data.

Domain

string

The domain name.

www.a.com

RequestBytes

integer

The volume of request traffic to the domain name. Unit: bytes.

3214

SessionCount

integer

The number of sessions.

12

GroupName

string

The organization to which the domain name belongs.

Google

ResponseBytes

integer

The volume of response traffic. Unit: bytes.

4582

Business

string

The business to which the domain name belongs.

Google

TotalBytes

integer

The total traffic volume. Unit: bytes.

8111126106

ApplicationNameList

array

The list of application layer protocols.

string

The application layer protocol.

HTTP

SrcIpCount

integer

The number of source IP addresses that are used to access the domain name.

2

SrcVpcCount

integer

The number of source VPCs that are used to access the domain name.

1

Examples

Success response

JSON format

{
  "TotalCount": 132,
  "RequestId": "133173B9-8010-5DF5-8B93-********",
  "DataList": [
    {
      "Domain": "www.a.com",
      "RequestBytes": 3214,
      "SessionCount": 12,
      "GroupName": "Google",
      "ResponseBytes": 4582,
      "Business": "Google",
      "TotalBytes": 8111126106,
      "ApplicationNameList": [
        "HTTP"
      ],
      "SrcIpCount": 2,
      "SrcVpcCount": 1
    }
  ]
}

Error codes

HTTP status code

Error code

Error message

Description

400 ErrorAliUid Aliuid invalid. The aliuid is invalid.
400 ErrorTimeError The time is invalid. The time is invalid.
400 ErrorDBSelectError A database select error occurred. The error message returned because an internal error has occurred in querying the database.
400 ErrorIntervalError The interval is invalid. The interval is invalid.
400 ErrorIpFormat The IP address is invalid. The IP address is invalid.
400 ErrorSecuritySuggest The security suggest is invalid. The security suggest is invalid.
400 ErrorSortError The sort is invalid. The sort is invalid.
400 ErrorOrderFailed The order is invalid. The order is invalid.
400 ErrorPageNo Either page number or page size is invalid. Either page number or page size is invalid.
400 ErrorDomainName The domain name is invalid. The domain name is invalid.
400 ErrorDataTypeError The data type is invalid. The data type is invalid.
400 ErrorMarshalJSON internal error. Internal error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.