All Products
Search
Document Center

Elastic Compute Service:DescribePrefixLists

Last Updated:Feb 04, 2024

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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID. You can call the DescribeRegions operation to query the most recent region list.

cn-chengdu
PrefixListNamestringNo

The name of the prefix list.

PrefixListNameSample
NextTokenstringNo

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****
MaxResultsintegerNo

The number of entries to return on each page.

Maximum value: 100.

Default value: 10.

10
AddressFamilystringNo

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
PrefixListIdarrayNo

The IDs of prefix list.

stringNo

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

pl-x1j1k5ykzqlixdcy****

Response parameters

ParameterTypeDescriptionExample
object
NextTokenstring

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

AAAAAdDWBF2****
RequestIdstring

The ID of the request.

38793DB8-A4B2-4AEC-BFD3-111234E9188D
PrefixListsobject []

Details about the prefix lists.

CreationTimestring

The time when the prefix list was created.

2021-02-20T07:11Z
AssociationCountinteger

The number of associated resources.

1
MaxEntriesinteger

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

20
Descriptionstring

The description of the prefix list.

This is description.
AddressFamilystring

The IP address family of the prefix list. Valid values:

  • IPv4
  • IPv6
IPv4
PrefixListNamestring

The name of the prefix list.

PrefixListNameSample
PrefixListIdstring

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 codeError codeError messageDescription
400InvalidParameter%sThe specified parameter is invalid.
400LimitExceed.PrefixListIdThe 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 timeSummary of changesOperation
2023-11-13The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    Added Error Codes: 404