调用 DescribePrefixLists 接口，查询满足指定条件的前缀列表。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action String 必选示例值：DescribePrefixLists

接口名称。当前 API 的名称为DescribePrefixLists。

Version String 必选示例值：2020-04-01

接口版本。当前 API 的版本为 2020-04-01。

PrefixListIds.N String 可选示例值：pl-bp1fg655nh68xyz9****

前缀列表的实例ID。

参数 - N：表示前缀列表的序号，单次调用数量上限100个。

多个前缀列表ID之间用&分隔。

PrefixListName String 可选示例值：PrefixList-1

要查询的前缀列表的名称。

IpVersion String 可选示例值：IPv4

前缀列表的IP版本。取值：

IPv4：IPv4版本。

IPv6：IPv6版本。

ProjectName String 可选示例值：default

前缀列表所属的项目。

TagFilters.N.Key String 可选示例值：k1

标签的标签键。

参数 - N：表示标签键的序号，取值范围：1～10。

多个标签键之间用&分隔。多个标签键之间的关系为逻辑“与（AND）”，即查询同时添加多个标签键的前缀列表。

不允许重复。

TagFilters.N.Values.N String 可选示例值：v1

标签的标签值。

第一个N：表示标签键的序号，取值范围：1～10。

第二个N：表示标签值的序号，取值范围：1～3。同一标签键多个标签值之间的关系为逻辑“或(OR)”，即查询同一标签键下添加其中一个标签值的前缀列表。

多个标签值之间用&分隔。

说明

若传入该参数，则必须先传入TagFilters.N.Key。

传入空字符串时，表示查询标签值为空的前缀列表。

PageNumber Integer 可选示例值：1

列表的页码。默认值为1。

说明

本参数即将下线，建议您使用NextToken和MaxResults进行分页查询。

PageSize Integer 可选示例值：20

分页查询时每页的行数。最大值为100，默认值为20。

说明

本参数即将下线，建议您使用NextToken和MaxResults进行分页查询。

NextToken String 可选示例值：caeba0bbb2be03f84eb48b699f0a****

分页查询凭证，用于标记分页的位置。

不填则从头开始查询。

传入之前调用本API返回的NextToken，则从该次API调用标记分页的位置往后开始查询。

MaxResults Integer 可选示例值：50

查询的数量，默认为 10，最大为100。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

RequestId String 示例值：2021062415303301022514515207C4****

请求ID。

TotalCount Integer 示例值：2

符合条件的前缀列表总数。

说明

本参数即将下线，使用NextToken和MaxResults分页查询时，此参数无意义。

PageNumber Integer 示例值：1

当前页码。

说明

本参数即将下线，建议您使用NextToken和MaxResults进行分页查询。

PageSize Integer 示例值：10

当前分页的行数。

说明

本参数即将下线，建议您使用NextToken和MaxResults进行分页查询。

NextToken String 示例值：caeba0bbb2be03f84eb48b699f0a****

本次API调用返回的查询凭证，标记分页的位置，用于下一次查询。返回为空表示没有下一页。

PrefixLists Object[] 示例值：-

VPC前缀列表集合。

PrefixListId String 示例值：pl-bp1fg655nh68xyz9****

VPC前缀列表的ID。

PrefixListName String 示例值：PrefixList-1

VPC前缀列表名称。

Description String 示例值：PrefixList_Common

VPC前缀列表描述信息。

IpVersion String 示例值：IPv4

前缀列表的IP版本。

MaxEntries Integer 示例值：10

最大条目数，即前缀列表做多可添加条目的数量。

AssociationCount Integer 示例值：5

前缀列表关联资源数目。

Cidrs String[] 示例值：1.XX.XX.0/24

前缀列表的CIDR地址块信息。

Status String 示例值：Available

前缀列表的状态。取值：

Available：可用。

Creating：创建中。

Deleting：删除中。

Pending：修改中。

ProjectName String 示例值：default

前缀列表所属项目的名称。

Tags Object[] 示例值：-

前缀列表的标签信息。

Key String 示例值：k1

标签的标签键。

Value String 示例值：v1

标签的标签值。

CreationTime String 示例值：2017-12-05T22:40:00+08:00

VPC前缀列表的创建时间。

UpdateTime String 示例值：2017-12-05T22:40:00+08:00

VPC前缀列表的修改时间。

请求示例

返回示例

错误码

状态码	错误码	错误信息	说明
400	DryRunOperation	Exception raised to indicate a successfully authorized action when the DryRun flag is set to true.	该请求设置为DryRun操作，操作授权已获得许可，但未被实际执行。
400	InvalidMaxResults.Malformed	The specified parameter MaxResults is malformed.	查询数量不合法。
400	InvalidNextToken.Malformed	The specified parameter NextToken is invalid.	查询 NextToken 不合法。
400	InvalidPage.Malformed	The specified page is malformed.	指定的分页参数不合法。
400	InvalidParameter.IpVersion	The specified IP version is not supported.	指定的IP地址类型不支持。
400	InvalidTagFilter.Disorder	The specified index order of tag filter is malformed.	指定标签过滤项的索引顺序参数格式不合法。
400	InvalidTagFilterKey.Malformed	The specified parameter tag filter key is invalid.	过滤标签键不合法。
400	InvalidTagFilterValue.Malformed	The specified parameter tag filter value is invalid.	过滤标签值不合法。
400	LimitExceeded.PrefixListId	You've reached the limit on the number of prefix list IDs that you can describe.	已达到可查询的前缀列表ID数量上限。
400	LimitExceeded.TagFilterKey	You've reached the limit on the number of tag keys that you can filter.	已达到单次可指定过滤标签键数量的上限。
400	LimitExceeded.TagFilterValue	You've reached the limit on the number of tag values that you can filter.	已达到单次可指定过滤标签值数量的上限。

私有网络