DescribePrefixListAttributes -

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 of the prefix list. You can call the DescribeRegions operation to query the most recent region list.
PrefixListId	String	Yes	pl-x1j1k5ykzqlixdcy****	The ID of the prefix list.

Response parameters


Parameter	Type	Example	Description
CreationTime	String	2021-02-20T07:11Z	The time when the prefix list was created.
MaxEntries	Integer	10	The maximum number of entries that the prefix list can contain.
RequestId	String	38793DB8-A4B2-4AEC-BFD3-111234E9188D	The ID of the request.
Description	String	This is description.	The description of the prefix list.
AddressFamily	String	IPv4	The IP address family of the prefix list. Valid values: IPv4 IPv6
PrefixListName	String	PrefixListNameSample	The name of the prefix list.
PrefixListId	String	pl-x1j1k5ykzqlixdcy****	The ID of the prefix list.
Entries	Array of Entry		Details about the entries in the prefix list.
Entry
Description	String	Description Sample 01	The description of the entry in the prefix list.
Cidr	String	192.168.1.0/24	The CIDR block in the entry in the prefix list.

Examples

Sample requests

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

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes


HTTP status code	Error code	Error message	Description
404	InvalidPrefixListId.NotFound	The specified prefix list was not found.	The error message returned because the specified prefix list does not exist.

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