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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 ListPrefixLists

系统规定参数。取值：ListPrefixLists。
PrefixListIds.N String 否 pl-0b7hwu67****

前缀列表的实例ID。
NextToken String 否 FFmyTO70tTpLG6I3FmYAXGKPd****

是否拥有下一次查询的令牌（Token）。取值：

  • 第一次查询和没有下一次查询时，均无需填写。
  • 如果有下一次查询，取值为上一次API调用返回的NextToken值。
MaxResults Long 否 20

分批次查询时每次显示的条目数。取值范围：1~100，默认值为20。
ResourceGroupId String 否 rg-bp67acfmxazb4ph****

前缀列表所属的资源组ID。
Tags.N.Key String 否 FinanceDept

标签键。最多支持输入20个标签键。一旦传入该值，则不允许为空字符串。

一个标签键最多支持64个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-），不能以aliyun和acs:开头，不能包含http://或者https://。
Tags.N.Value String 否 FinanceJoshua

标签值。最多支持输入20个标签值。一旦传入该值，可以为空字符串。

一个标签值最多支持128个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-），不能以aliyun和acs:开头，不能包含http://或者https://。
RegionId String 是 cn-hangzhou

要查询前缀列表的信息的地域ID。

您可以通过调用DescribeRegions接口获取地域ID。
PrefixListName String 否 name

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

名称长度为1～128个字符，不能以http://或https://开头。

返回数据

名称 类型 示例值 描述
RequestId String DF72F7BB-5DFA-529C-887E-B0BB70D89C4F

请求ID。
NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

是否拥有下一次查询的令牌（Token）。取值：

  • 如果NextToken为空表示没有下一次查询。
  • 如果NextToken有返回值，该取值表示下一次查询开始的令牌。
TotalCount Long 1

查询到的列表数目。
MaxResults Long 20

分批次查询时每次显示的条目数。取值范围：1~100，默认值为20。
PrefixLists Array of PrefixList

查询到的前缀列表的列表信息。
PrefixListId String pl-m5estsqsdqwg88hjf****

查询到的前缀列表ID。
PrefixListName String test

前缀列表的名称。
PrefixListDescription String Created with oss service by system.

前缀列表的描述信息。
IpVersion String IPV4

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

  • IPV4：IPv4版本。
  • IPV6：IPv6版本。
CreationTime String 2022-07-12T14:22:32Z

前缀列表的创建时间。
CidrBlocks Array of String 100.115.XX.XX/24

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

前缀列表的共享类型。取值：

  • Shared：表示该前缀列表为共享的前缀列表。
  • 空：表示该前缀列表不是共享的前缀列表。
MaxEntries Integer 10

前缀列表中CIDR地址块的最大条目数。
Status String Created

前缀列表的状态。取值：

  • Created：已创建。
  • Deleted：已删除。
  • Modifying：修改中。
OwnerId String 1210123456123456

前缀列表所属的阿里云账号（主账号）。
PrefixListStatus String Created

前缀列表的状态。取值：

  • Created：已创建。
  • Deleted：已删除。
  • Modifying：修改中。
说明 该参数与Status含义和取值相同。
RegionId String cn-hangzhou

查询到的前缀列表信息的地域ID。
ResourceGroupId String rg-bp67acfmxazb4ph****

前缀列表所属的资源组ID。
Tags Array of Tag

标签列表。
Key String FinanceDept

标签键。
Value String FinanceJoshua

标签值。

示例

请求示例

http(s)://[Endpoint]/?Action=ListPrefixLists
&PrefixListIds=["pl-0b7hwu67****"]
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd****
&MaxResults=20
&ResourceGroupId=rg-bp67acfmxazb4ph****
&Tags=[{"Key":"FinanceDept","Value":"FinanceJoshua"}]
&RegionId=cn-hangzhou
&PrefixListName=name
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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"
    } ]
  } ]
}

错误码

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

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