调用ListPrefixLists查询前缀列表的列表信息_专有网络 VPC-阿里云帮助中心

调用ListPrefixLists接口查询前缀列表的列表信息。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
vpc:ListPrefixLists	List	PrefixList acs:vpc:{#regionId}:{#accountId}:prefixlist/*	无	无

请求参数

名称	类型	必填	描述	示例值
PrefixListIds	array	否	要查询的前缀列表ID。N的取值范围为1~100，即一次最多查询100个前缀列表。
	string	否	前缀列表的实例ID。	pl-0b7hwu67****
NextToken	string	否	是否拥有下一次查询的令牌（Token）。取值：第一次查询和没有下一次查询时，均无需填写。如果有下一次查询，取值为上一次API调用返回的NextToken值。	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	long	否	分批次查询时每次显示的条目数。取值范围：1~100，默认值为20。	20
ResourceGroupId	string	否	前缀列表所属的资源组ID。	rg-bp67acfmxazb4ph****
Tags	object []	否	标签列表。
Key	string	否	标签键。最多支持输入20个标签键。一旦传入该值，则不允许为空字符串。一个标签键最多支持64个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-），不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	FinanceDept
Value	string	否	标签值。最多支持输入20个标签值。一旦传入该值，可以为空字符串。一个标签值最多支持128个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-），不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	FinanceJoshua
RegionId	string	是	要查询前缀列表的信息的地域ID。您可以通过调用DescribeRegions接口获取地域ID。	cn-hangzhou
PrefixListName	string	否	要查询的前缀列表的名称。名称长度为1～128个字符，不能以`http://`或`https://`开头。	name

返回参数

名称	类型	描述	示例值
	object	请求ID。
RequestId	string	请求ID。	DF72F7BB-5DFA-529C-887E-B0BB70D89C4F
NextToken	string	是否拥有下一次查询的令牌（Token）。取值：如果NextToken为空表示没有下一次查询。如果NextToken有返回值，该取值表示下一次查询开始的令牌。	FFmyTO70tTpLG6I3FmYAXGKPd****
TotalCount	long	查询到的列表数目。	1
MaxResults	long	分批次查询时每次显示的条目数。取值范围：1~100，默认值为20。	20
PrefixLists	object []	查询到的前缀列表的列表信息。
PrefixListId	string	查询到的前缀列表ID。	pl-m5estsqsdqwg88hjf****
PrefixListName	string	前缀列表的名称。	test
PrefixListDescription	string	前缀列表的描述信息。	Created with oss service by system.
IpVersion	string	前缀列表的IP版本。取值： IPV4：IPv4版本。 IPV6：IPv6版本。	IPV4
CreationTime	string	前缀列表的创建时间。	2022-07-12T14:22:32Z
CidrBlocks	array	前缀列表的CIDR地址块信息。
	string	前缀列表的CIDR地址块信息。	100.115.XX.XX/24
ShareType	string	前缀列表的共享类型。取值： Shared：表示该前缀列表为共享的前缀列表。空：表示该前缀列表不是共享的前缀列表。	Shared
MaxEntries	integer	前缀列表中CIDR地址块的最大条目数。	10
Status	string	前缀列表的状态。取值： Created：已创建。 Deleted：已删除。 Modifying：修改中。	Created
OwnerId	string	前缀列表所属的阿里云账号（主账号）。	1210123456123456
PrefixListStatus	string	前缀列表的状态。取值： Created：已创建。 Deleted：已删除。 Modifying：修改中。说明该参数与Status含义和取值相同。	Created
RegionId	string	查询到的前缀列表信息的地域ID。	cn-hangzhou
ResourceGroupId	string	前缀列表所属的资源组ID。	rg-bp67acfmxazb4ph****
Tags	object []	标签列表。
Key	string	标签键。	FinanceDept
Value	string	标签值。	FinanceJoshua

示例

正常返回示例

JSON格式

{
  "RequestId": "DF72F7BB-5DFA-529C-887E-B0BB70D89C4F",
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "TotalCount": 1,
  "MaxResults": 20,
  "PrefixLists": [
    {
      "PrefixListId": "pl-m5estsqsdqwg88hjf****",
      "PrefixListName": "test",
      "PrefixListDescription": "Created with oss service by system.",
      "IpVersion": "IPV4",
      "CreationTime": "2022-07-12T14:22:32Z",
      "CidrBlocks": [
        "100.115.XX.XX/24"
      ],
      "ShareType": "Shared",
      "MaxEntries": 10,
      "Status": "Created",
      "OwnerId": "1210123456123456",
      "PrefixListStatus": "Created",
      "RegionId": "cn-hangzhou",
      "ResourceGroupId": "rg-bp67acfmxazb4ph****",
      "Tags": [
        {
          "Key": "FinanceDept",
          "Value": "FinanceJoshua"
        }
      ]
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	IllegalParam.NextToken	The specified NextToken is invalid.	指定的NextToken参数不合法，请检查该参数是否正确。

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史