All Products
Search
Document Center

Cloud Firewall:DescribePrefixLists

Last Updated:Nov 25, 2025

Queries prefix lists.

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

SourceIp

string

No

The source IP address of the request.

47.100.XX.XX

RegionNo

string

Yes

The region ID of the instance.

cn-shenzhen

Response elements

Element

Type

Description

Example

object

The response object.

RequestId

string

The ID of the request.

67FD76C2-C493-5815-8107-643FD7AB77C7

PrefixList

array<object>

An array that consists of the information about the prefix lists.

object

The information about the prefix list.

PrefixListId

string

The ID of the prefix list.

pl-uf64nco3ujjqchx6aaji

PrefixListName

string

The name of the prefix list.

participant-name

Description

string

The description of the prefix list.

TCP_14900-14911

CreationTime

string

The time when the prefix list was created.

2023-10-16T08:31:06Z

AssociationCount

integer

The number of linked instances.

2

MaxEntries

integer

The maximum number of entries that the prefix list can contain.

20

AddressFamily

string

The address family of the prefix list. Valid values:

  • IPv4

  • IPv6

IPv4

Examples

Success response

JSON format

{
  "RequestId": "67FD76C2-C493-5815-8107-643FD7AB77C7",
  "PrefixList": [
    {
      "PrefixListId": "pl-uf64nco3ujjqchx6aaji",
      "PrefixListName": "participant-name",
      "Description": "TCP_14900-14911",
      "CreationTime": "2023-10-16T08:31:06Z",
      "AssociationCount": 2,
      "MaxEntries": 20,
      "AddressFamily": "IPv4"
    }
  ]
}

Error codes

HTTP status code

Error code

Error message

Description

400 ErrorParameters parameters invalid. Parameter error, please check and try again.
400 ErrorMarshalJSON An error occurred while encoding JSON. An error occurred while encoding JSON.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.