GetVpcPrefixListEntries - Virtual Private Cloud - Alibaba Cloud Documentation Center

Queries the information about a prefix list.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
vpc:GetVpcPrefixListEntries	get	PrefixList acs:vpc:{#regionId}:{#accountId}:prefixlist/{#PrefixListId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
PrefixListId	string	Yes	The ID of the prefix list that you want to query.	pl-0b7hwu67****
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. Valid values: You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	long	No	The number of entries per page. Valid values: 1 to 100. Default value: 20.	20
RegionId	string	Yes	The region ID of the prefix list. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	4EC47282-1B74-4534-BD0E-403F3EE64CAF
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results. Valid values: If NextToken is empty, no next page exists. If a value is returned for NextToken, the value indicates the token that is used for the next request to retrieve a new page of results.	FFmyTO70tTpLG6I3FmYAXGKPd****
TotalCount	long	The total number of entries returned.	1
Count	long	The number of entries.	1
PrefixListEntry	array<object>	The information about the prefix list.
PrefixListCidrs	object
PrefixListId	string	The ID of the prefix list.	pl-0b7hwu67****
Cidr	string	The CIDR blocks specified in the prefix list.	192.168.0.0/16
Description	string	The description of the prefix list.	description
RegionId	string	The region ID of the prefix list.	cn-hangzhou

Examples

Sample success responses

JSONformat

{
  "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

HTTP status code	Error code	Error message	Description
400	IllegalParam.NextToken	The specified NextToken is invalid.	The specified NextToken is invalid.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-05-09	The Error code has changed	View Change Details