You need to enable JavaScript to run this app.
导航
私有网络
  • 文档首页
    • /
  • 私有网络

DescribePrefixLists

最近更新时间：2024.05.17 08:35:46

首次发布时间：2023.09.05 08:11:46

我的收藏

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

调试

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

请求参数

参数名称
类型
是否必选
示例值
描述
ActionString是DescribePrefixLists要执行的操作，取值：DescribePrefixLists。
VersionString是2020-04-01API版本信息，取值为：2020-04-01。

PrefixListIds.N

String

否

PrefixListIds.1=pl-bp1fg655nh68xyz9****&PrefixListIds.2=pl-bp1fg655nh688888****

前缀列表的实例ID。

  • 参数 - N：表示前缀列表的序号，单次调用数量上限100个。
  • 多个前缀列表ID之间用&分隔。
PrefixListNameString否PrefixList-1要查询的前缀列表的名称。

IpVersion

String

否

IPv4

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

  • IPv4：IPv4版本。
  • IPv6：IPv6版本。
ProjectNameString否default前缀列表所属的项目。

TagFilters.N.Key

String

否

TagFilters.1.Key=k1&TagFilters.2.Key=k2&TagFilters.3.Key=k3

标签的标签键。

  • 参数 - N：表示标签键的序号，取值范围：1～10。
  • 多个标签键之间用&分隔。多个标签键之间的关系为逻辑“与（AND）”，即查询同时添加多个标签键的前缀列表。
  • 不允许重复。

TagFilters.N.Values.N

String

否

TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2&TagFilters.3.Values.1=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调用标记分页的位置往后开始查询。
MaxResultsInteger否50查询的数量，默认为 10，最大为100。

返回数据

参数名称
类型
示例值
描述
RequestIdString2021062415303301022514515207C4****请求ID。

TotalCount

Integer

2

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

说明

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

PageNumber

Integer

1

当前页码。

说明

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

PageSize

Integer

10

当前分页的行数。

说明

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

NextToken

String

caeba0bbb2be03f84eb48b699f0a****

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

PrefixListsArray-VPC前缀列表集合。具体请见下表“PrefixList结构”。

PrefixList结构

参数名称
类型
示例值
描述
PrefixListIdStringpl-bp1fg655nh68xyz9****VPC前缀列表的ID。
PrefixListNameStringPrefixList-1VPC前缀列表名称。
DescriptionStringPrefixList_CommonVPC前缀列表描述信息。
IpVersionStringIPv4前缀列表的IP版本。
MaxEntriesInteger10最大条目数，即前缀列表做多可添加条目的数量。
AssociationCountInteger5前缀列表关联资源数目。
CidrsArray of String1.XX.XX.0/24,2.XX.XX.0/24前缀列表的CIDR地址块信息。

Status

String

Available

前缀列表的状态。取值：

  • Available：可用。
  • Creating：创建中。
  • Deleting：删除中。
  • Pending：修改中。
ProjectNameStringdefault前缀列表所属项目的名称。
TagsArray of Struct-前缀列表的标签信息。具体请参见下表“Tag结构”。
CreationTimeString2017-12-05T22:40:00+08:00VPC前缀列表的创建时间。
UpdateTimeString2017-12-05T22:40:00+08:00VPC前缀列表的修改时间。

Tag结构

参数名称
类型
示例值
描述
KeyStringk1标签的标签键。
ValueStringv1标签的标签值。

请求示例

GET /?Action=DescribePrefixLists&Version=2020-04-01&IpVersion=IPv4 HTTP/1.1
Host: open.volcengineapi.com
Service: vpc
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021062415303301022514515207C4****",
        "Action": "DescribePrefixLists",
        "Version": "2020-04-01",
        "Service": "vpc",
        "Region": "cn-beijing"
    },
    "Result":{
        "RequestId": "2021062415303301022514515207C4****",
        "PageNumber": 1,
        "PageSize": 20,
        "TotalCount":1,
        "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
        "PrefixLists": [
            {
                 "PrefixListId": "pl-bp1fg655nh68xyz9****",
                 "PrefixListName": "PrefixList-1",
                 "Description": "PrefixList_Common",
                 "IpVersion": "IPv4",
                 "MaxEntries": 50,
                 "AssociationCount": 5,
                 "Cidrs": [
                     "1.XX.XX.0/24"，
                     "2.XX.XX.0/24"
                ]
                "Status": "Available",
                "ProjectName": "default",
                "Tags": [
                    {
                        "Key":"k1",
                        "Value":"v1"
                    },
                    {
                        "Key":"k2",
                        "Value":""
                    }
                ],  
                "CreationTime": "2021-07-22T10:51:41+08:00",
                "UpdateTime": "2021-07-23T11:55:12+08:00"          
            }
         ]
    }
}

错误码

此处仅展示当前API的错误码，更多错误码请参见公共错误码。

HttpCode
错误码
错误信息
描述
400InvalidMaxResults.MalformedThe specified parameter MaxResults is malformed.查询数量不合法。
400InvalidNextToken.MalformedThe specified parameter NextToken is invalid.查询 NextToken 不合法。
400InvalidPage.MalformedThe specified page is malformed.指定的分页参数不合法。
400InvalidParameter.IpVersionThe specified IP version is not supported.指定的IP地址类型不支持。
400InvalidTagFilter.DisorderThe specified index order of tag filter is malformed.指定标签过滤项的索引顺序参数格式不合法。
400InvalidTagFilterKey.MalformedThe specified parameter tag filter key is invalid.过滤标签键不合法。
400InvalidTagFilterValue.MalformedThe specified parameter tag filter value is invalid.过滤标签值不合法。
400LimitExceeded.PrefixListIDYou've reached the limit on the number of prefix list IDs that you can describe.已达到可查询的前缀列表ID数量上限。
400LimitExceeded.TagFilterKeyYou'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.

已达到单次可指定过滤标签值数量的上限。

403ForbiddenYou are not authorized to access VPC prefix list.您无权限访问VPC前缀列表。