GetVpcPrefixListEntries -

Queries the information about a prefix list.

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	GetVpcPrefixListEntries	The operation that you want to perform. Set the value to GetVpcPrefixListEntries.
PrefixListId	String	Yes	pl-0b7hwu67****	The ID of the prefix list that you want to query.
NextToken	String	No	FFmyTO70tTpLG6I3FmYAXGKPd****	The token that is used for the next query. Valid values: If this is your first query and no next queries are to be sent, ignore this parameter. If a next query is to be performed, set the value to the NextToken value returned in the last call to the ListenerCertificates operation.
MaxResults	Long	No	20	The number of entries to return on each page. Valid values: 1 to 100. Default value: 20.
RegionId	String	Yes	cn-hangzhou	The region ID of the prefix list. You can call the DescribeRegions operation to query available regions.

Response parameters


Parameter	Type	Example	Description
RequestId	String	4EC47282-1B74-4534-BD0E-403F3EE64CAF	The ID of the request.
NextToken	String	FFmyTO70tTpLG6I3FmYAXGKPd****	The token that is used for the next query. Valid values: If no value is returned for NextToken, no next queries are sent. If NextToken is not empty, the value indicates the token that is used for the next query.
TotalCount	Long	1	The total number of entries returned.
Count	Long	1	The number of entries.
PrefixListEntry	Array of PrefixListCidrs		The information about the prefix list.
PrefixListId	String	pl-0b7hwu67****	The ID of the prefix list.
Cidr	String	192.168.0.0/16	The CIDR blocks specified in the prefix list.
Description	String	description	The description of the prefix list.
RegionId	String	cn-hangzhou	The region ID of the prefix list.

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetVpcPrefixListEntries
&PrefixListId=pl-0b7hwu67****
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd****
&MaxResults=20
&RegionId=cn-hangzhou
&Common request parameters

Sample success responses

XML format

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

<GetVpcPrefixListEntriesResponse>
    <RequestId>4EC47282-1B74-4534-BD0E-403F3EE64CAF</RequestId>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>
    <TotalCount>1</TotalCount>
    <Count>1</Count>
    <PrefixListEntry>
        <PrefixListId>pl-0b7hwu67****</PrefixListId>
        <Cidr>192.168.0.0/16</Cidr>
        <Description>description</Description>
        <RegionId>cn-hangzhou</RegionId>
    </PrefixListEntry>
</GetVpcPrefixListEntriesResponse>

JSON format

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

{
  "RequestId" : "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
  "NextToken" : "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "TotalCount" : 1,
  "Count" : 1,
  "PrefixListEntry" : [ {
    "PrefixListId" : "pl-0b7hwu67****",
    "Cidr" : "192.168.0.0/16",
    "Description" : "description",
    "RegionId" : "cn-hangzhou"
  } ]
}

Error codes


HttpCode	Error code	Error message	Description
400	IllegalParam.NextToken	The specified NextToken is invalid.	The error message returned because the specified NextToken is invalid.

For a list of error codes, see Service error codes.