Queries the information of one or more prefix lists.

Description

You can specify the AddressFamily, PrefixListId.N, PrefixListName request parameters. The specified request parameters are included in the filter conditions and have logical AND relations. If a parameter is not specified, it is not 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribePrefixLists

The operation that you want to perform. Set the value to DescribePrefixLists.

RegionId String Yes cn-chengdu

The region ID.

MaxResults Integer No 10

The maximum number of entries to return on each page.

Maximum value: 100.

Default value: 10.

NextToken String No AAAAAdDWBF2****

The query token. Set the value to the NextToken value returned from a previous call to the DescribePrefixLists operation. Leave this parameter empty when you call this operation for the first time.

AddressFamily String No IPv4

The address family of the prefix list. Valid values:

  • IPv4
  • IPv6

This parameter is empty by default, which indicates that all prefix lists are to be queried.

PrefixListId.N RepeatList No pl-x1j1k5ykzqlixdcy****

The ID of prefix list N. Valid values of N: 0 to 100.

PrefixListName String No PrefixListNameSample

The name of the prefix list.

Response parameters

Parameter Type Example Description
RequestId String 38793DB8-A4B2-4AEC-BFD3-111234E9188D

The ID of the request.

NextToken String AAAAAdDWBF2****

The query token returned in this call. If the return value is empty, no more data is returned.

PrefixLists Array of PrefixList

Details about the prefix lists.

PrefixList
AddressFamily String IPv4

The address family of the prefix list. Valid values:

  • IPv4
  • IPv6
AssociationCount Integer 1

The amount of associated resources.

CreationTime String 2021-02-20T07:11Z

The time when the prefix list was created.

Description String This is description.

The description of the prefix list.

MaxEntries Integer 20

The maximum number of entries that the prefix list supports.

PrefixListId String pl-x1j1k5ykzqlixdcy****

The ID of the prefix list.

PrefixListName String PrefixListNameSample

The name of the prefix list.

Examples

Sample requests

https://ecs.aliyuncs.com/?Action=DescribePrefixLists
&RegionId=cn-chengdu
&PrefixListId.1=pl-x1j1k5ykzqlixdcy****
&<Common request parameters>

Sample success responses

XML format

<DescribePrefixListsResponse>
      <RequestId>38793DB8-A4B2-4AEC-BFD3-111234E9188D</RequestId>
      <PrefixLists>
            <PrefixList>
                  <MaxEntries>20</MaxEntries>
                  <Description>This is description.</Description>
                  <PrefixListId>pl-x1j1k5ykzqlixdcy****</PrefixListId>
                  <PrefixListName>PrefixListNameSample</PrefixListName>
                  <CreationTime>2021-02-20T07:11Z</CreationTime>
                  <AddressFamily>IPv4</AddressFamily>
                  <AssociationCount>1</AssociationCount>
            </PrefixList>
      </PrefixLists>
</DescribePrefixListsResponse>

JSON format

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

Error codes

HTTP sta Error code Error message Description
400 InvalidParameter %s The error message returned because a specified parameter is invalid.
400 LimitExceed.PrefixListId The specified number of PrefixListId exceeds the limit. The error message returned because the maximum number of prefix lists has been reached.
404 NotSupported.GrayFunction The prefix list is a gray-scale function, not currently supported. The error message returned because this operation is not supported. The prefix list feature is in invitational preview.

For a list of error codes, visit the API Error Center.