DescribePrefixLists-阿里云帮助中心

Describes one or more 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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-cloudfirewall:DescribePrefixLists

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The source IP address.	47.100.XX.XX
RegionNo	string	Yes	The region ID.	cn-shenzhen

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	67FD76C2-C493-5815-8107-643FD7AB77C7
PrefixList	array<object>	An array of prefix lists.
	object	The details of a prefix list.
PrefixListId	string	The prefix list ID.	pl-uf64nco3ujjqchx6aaji
PrefixListName	string	The prefix list name.	participant-name
Description	string	The description of the prefix list.	TCP_14900-14911
CreationTime	string	The time the prefix list was created. The timestamp is in ISO 8601 format: `yyyy-MM-ddTHH:mm:ssZ`.	2023-10-16T08:31:06Z
AssociationCount	integer	The number of associated resources.	2
MaxEntries	integer	The maximum number of entries in the prefix list.	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.