调用DescribePrefixLists API查询前缀列表-云服务器 ECS-阿里云-阿里云帮助中心

调用DescribePrefixLists查询一个或多个前缀列表的信息。

接口说明

请求参数AddressFamily、PrefixListId.N和PrefixListName类似于过滤器，为逻辑与（AND）关系。如果某一参数为空，则过滤器不起作用。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
ecs:DescribePrefixLists	get	*PrefixList `acs:ecs:{#regionId}:{#accountId}:prefixlist/{#PrefixListId}`	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-chengdu
PrefixListName	string	否	前缀列表的名称。	PrefixListNameSample
NextToken	string	否	查询凭证（Token）。取值为上一次调用该接口返回的`NextToken`参数值，初次调用接口时无需设置该参数。	AAAAAdDWBF2****
MaxResults	integer	否	分页查询时每页行数。最大值：100。默认值：10。	10
AddressFamily	string	否	前缀列表的地址族。取值范围： IPv4。 IPv6。默认值：空，查询所有前缀列表信息。	IPv4
PrefixListId	array	否	前缀列表 ID。N 的取值范围：0~100。
	string	否	前缀列表 ID。N 的取值范围：0~100。	pl-x1j1k5ykzqlixdcy****
ResourceGroupId	string	否	前缀列表所属的企业资源组 ID。	rg-bp67acfmxazb4p****
Tag	array<object>	否	标签列表。
	object	否	标签列表。
Key	string	否	前缀列表的标签键。N 的取值范围：1~20。一旦传入该值，则不允许为空字符串。最多支持 128 个字符，不能以 aliyun 和 acs:开头，不能包含`http://或者 https://`。	TestKey
Value	string	否	前缀列表的标签值。N 的取值范围：1~20。该值可以为空字符串。最多支持 128 个字符，不能包含`http://或 https://`。	TestValue

返回参数

名称	类型	描述	示例值
	object
NextToken	string	本次调用返回的查询凭证（Token）。当该返回值为空时，表示无更多返回的数据信息。	AAAAAdDWBF2****
RequestId	string	请求 ID。	38793DB8-A4B2-4AEC-BFD3-111234E9188D
PrefixLists	array<object>	前缀列表信息组成的数组。
PrefixList	object
CreationTime	string	前缀列表的创建时间。	2021-02-20T07:11Z
AssociationCount	integer	关联资源的数量。	1
MaxEntries	integer	前缀列表支持的最大条目容量。	20
Description	string	前缀列表的描述信息。	This is description.
AddressFamily	string	前缀列表的地址族。可能值： IPv4。 IPv6。	IPv4
PrefixListName	string	前缀列表的名称。	PrefixListNameSample
PrefixListId	string	前缀列表 ID。	pl-x1j1k5ykzqlixdcy****
Tags	array<object>	标签列表。
Tag	object	标签列表。
TagValue	string	前缀列表的标签键。N 的取值范围：1~20。一旦传入该值，则不允许为空字符串。最多支持 128 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	TestKey
TagKey	string	前缀列表的标签值。N 的取值范围：1~20。该值可以为空字符串。最多支持 128 个字符，不能包含`http://或 https://`。	TestValue
ResourceGroupId	string	前缀列表所属的企业资源组 ID。	rg-bp67acfmxazb4p****

示例

正常返回示例

JSON格式

{
  "NextToken": "AAAAAdDWBF2****",
  "RequestId": "38793DB8-A4B2-4AEC-BFD3-111234E9188D",
  "PrefixLists": {
    "PrefixList": [
      {
        "CreationTime": "2021-02-20T07:11Z",
        "AssociationCount": 1,
        "MaxEntries": 20,
        "Description": "This is description.",
        "AddressFamily": "IPv4",
        "PrefixListName": "PrefixListNameSample",
        "PrefixListId": "pl-x1j1k5ykzqlixdcy****",
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestKey",
              "TagKey": "TestValue\n"
            }
          ]
        },
        "ResourceGroupId": "rg-bp67acfmxazb4p****\n"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter	%s	无效的参数。
400	LimitExceed.PrefixListId	The specified number of PrefixListId exceeds the limit.	PrefixListId的数量超出限制。
404	InvalidRegionId.NotFound	The specified RegionId does not exist.	指定的地域 ID 不存在。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2025-04-21	OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2025-01-02	OpenAPI 描述信息更新、OpenAPI 错误码发生变更	查看变更详情
2023-11-13	OpenAPI 错误码发生变更	查看变更详情