Queries the details about a specific prefix list, including the name, address family, maximum number of entries, and details about entries.

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 DescribePrefixListAttributes

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

RegionId String Yes cn-chengdu

The region ID.

PrefixListId String Yes pl-x1j1k5ykzqlixdcy****

The ID of the prefix list.

Response parameters

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

The ID of the request.

PrefixListId String pl-x1j1k5ykzqlixdcy****

The ID of the prefix list.

PrefixListName String PrefixListNameSample

The name of the prefix list.

AddressFamily String IPv4

The address family of the prefix list. Valid values:

  • IPv4
  • IPv6
MaxEntries Integer 10

The maximum number of entries that the prefix list supports.

Description String This is description.

The description of the prefix list.

CreationTime String 2021-02-20T07:11Z

The time when the prefix list was created.

Entries Array of Entry

Details about the entries in the prefix list.

Entry
Cidr String 192.168.1.0/24

Details about CIDR blocks of the entry in the prefix list.

Description String Description Sample 01

The description of the entry in the prefix list.

Examples

Sample requests

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

Sample success responses

XML format

<DescribePrefixListAttributesResponse>
      <MaxEntries>10</MaxEntries>
      <Description>This is description.</Description>
      <RequestId>38793DB8-A4B2-4AEC-BFD3-111234E9188D</RequestId>
      <PrefixListId>pl-x1j1k5ykzqlixdcy****</PrefixListId>
      <PrefixListName>PrefixListNameSample</PrefixListName>
      <CreationTime>2021-02-20T07:11Z</CreationTime>
      <Entries>
            <Entry>
                  <Description>Description Sample 01</Description>
                  <Cidr>192.168.1.0/24</Cidr>
            </Entry>
      </Entries>
      <AddressFamily>IPv4</AddressFamily>
</DescribePrefixListAttributesResponse>

JSON format

{
  "MaxEntries": 10,
  "Description": "This is description.",
  "RequestId": "38793DB8-A4B2-4AEC-BFD3-111234E9188D",
  "PrefixListId": "pl-x1j1k5ykzqlixdcy****",
  "PrefixListName": "PrefixListNameSample",
  "CreationTime": "2021-02-20T07:11Z",
  "Entries": {
    "Entry": [
      {
        "Description": "Description Sample 01",
        "Cidr": "192.168.1.0/24"
      }
    ]
  },
  "AddressFamily": "IPv4"
}

Error codes

HTTP status Error code Error message Description
404 InvalidPrefixListId.NotFound The specified prefix list was not found. The error message returned because the prefix list does not exist.
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.