DescribePrefixLists - Elastic Compute Service - Alibaba Cloud Documentation Center

Queries the information of one or more prefix lists.

Operation description

Description

You can specify the AddressFamily, PrefixListId.N, and PrefixListName request parameters to be queried. Specified parameters have logical AND relations. Only the specified parameters are included in the filter conditions.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ecs:DescribePrefixLists	get	PrefixList acs:ecs:{#regionId}:{#accountId}:prefixlist/{#PrefixListId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-chengdu
PrefixListName	string	No	The name of the prefix list.	PrefixListNameSample
NextToken	string	No	The query token. Set the value to the `NextToken` value returned in the previous call to the DescribePrefixLists operation. Leave this parameter empty the first time you call this operation.	AAAAAdDWBF2****
MaxResults	integer	No	The number of entries to return on each page. Maximum value: 100. Default value: 10.	10
AddressFamily	string	No	The IP address family of the prefix list. Valid values: IPv4 IPv6 This parameter is empty by default, which indicates that all prefix lists are queried.	IPv4
PrefixListId	array	No	The IDs of prefix list.
	string	No	The ID of prefix list N. Valid values of N: 0 to 100.	pl-x1j1k5ykzqlixdcy****

Response parameters

Parameter	Type	Description	Example
	object
NextToken	string	The query token returned in this call. If the return value is empty, no more data is returned.	AAAAAdDWBF2****
RequestId	string	The ID of the request.	38793DB8-A4B2-4AEC-BFD3-111234E9188D
PrefixLists	array<object>	Details about the prefix lists.
	object
CreationTime	string	The time when the prefix list was created.	2021-02-20T07:11Z
AssociationCount	integer	The number of associated resources.	1
MaxEntries	integer	The maximum number of entries that the prefix list can contain.	20
Description	string	The description of the prefix list.	This is description.
AddressFamily	string	The IP address family of the prefix list. Valid values: IPv4 IPv6	IPv4
PrefixListName	string	The name of the prefix list.	PrefixListNameSample
PrefixListId	string	The ID of the prefix list.	pl-x1j1k5ykzqlixdcy****

Examples

Sample success responses

JSONformat

{
  "NextToken": "AAAAAdDWBF2****",
  "RequestId": "38793DB8-A4B2-4AEC-BFD3-111234E9188D",
  "PrefixLists": {
    "PrefixList": [
      {
        "CreationTime": "2021-02-20T07:11Z",
        "AssociationCount": 1,
        "MaxEntries": 20,
        "Description": "This is description.",
        "AddressFamily": "IPv4",
        "PrefixListName": "PrefixListNameSample",
        "PrefixListId": "pl-x1j1k5ykzqlixdcy****"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	%s	The specified parameter is invalid.
400	LimitExceed.PrefixListId	The specified number of PrefixListId exceeds the limit.	The number of specified prefix list IDs exceeds the upper limit.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-11-13	The Error code has changed	View Change Details