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

接口说明

请求参数AddressFamilyPrefixListId.NPrefixListName类似于过滤器,为逻辑与(AND)关系。如果某一参数为空,则过滤器不起作用。

调试

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

请求参数

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

系统规定参数。取值:DescribePrefixLists

RegionId String cn-chengdu

地域ID。

MaxResults Integer 10

分页查询时每页行数。

最大值:100

默认值:10

NextToken String AAAAAdDWBF2****

查询凭证(Token)。取值为上一次调用该接口返回的NextToken参数值,初次调用接口时无需设置该参数。

AddressFamily String IPv4

前缀列表的地址族。取值范围:

  • IPv4
  • IPv6

默认值:空,查询所有前缀列表信息。

PrefixListId.N RepeatList pl-x1j1k5ykzqlixdcy****

前缀列表ID。N的取值范围:0~100

PrefixListName String PrefixListNameSample

前缀列表的名称。

返回数据

名称 类型 示例值 描述
RequestId String 38793DB8-A4B2-4AEC-BFD3-111234E9188D

请求ID。

NextToken String AAAAAdDWBF2****

本次调用返回的查询凭证(Token)。当该返回值为空时,表示无更多返回的数据信息。

PrefixLists Array of PrefixList

前缀列表信息组成的数组。

PrefixList
AddressFamily String IPv4

前缀列表的地址族。可能值:

  • IPv4
  • IPv6
AssociationCount Integer 1

关联资源的数量。

CreationTime String 2021-02-20T07:11Z

前缀列表的创建时间。

Description String This is description.

前缀列表的描述信息。

MaxEntries Integer 20

前缀列表支持的最大条目容量。

PrefixListId String pl-x1j1k5ykzqlixdcy****

前缀列表ID。

PrefixListName String PrefixListNameSample

前缀列表的名称。

示例

请求示例

https://ecs.aliyuncs.com/?Action=DescribePrefixLists
&RegionId=cn-chengdu
&PrefixListId.1=pl-x1j1k5ykzqlixdcy****
&<公共请求参数>

正常返回示例

XML格式

<DescribePrefixListsResponse>
      <RequestId>38793DB8-A4B2-4AEC-BFD3-111234E9188D</RequestId>
      <PrefixLists>
            <PrefixList>
                  <MaxEntries>20</MaxEntries>
                  <Description>This is description.</Description>
                  <PrefixListId>pl-x1j1k5ykzqlixdcy****</PrefixListId>
                  <PrefixListName>PrefixListNameSample</PrefixListName>
                  <CreationTime>2021-02-20T07:11Z</CreationTime>
                  <AddressFamily>IPv4</AddressFamily>
                  <AssociationCount>1</AssociationCount>
            </PrefixList>
      </PrefixLists>
</DescribePrefixListsResponse>

JSON格式

{
  "RequestId": "38793DB8-A4B2-4AEC-BFD3-111234E9188D",
  "PrefixLists": {
    "PrefixList": [
      {
        "MaxEntries": 20,
        "Description": "This is description.",
        "PrefixListId": "pl-x1j1k5ykzqlixdcy****",
        "PrefixListName": "PrefixListNameSample",
        "CreationTime": "2021-02-20T07:11Z",
        "AddressFamily": "IPv4",
        "AssociationCount": 1
      }
    ]
  }
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidParameter %s 无效的参数。
400 LimitExceed.PrefixListId The specified number of PrefixListId exceeds the limit. PrefixListId的数量超出限制。
404 NotSupported.GrayFunction The prefix list is a gray-scale function, not currently supported. 前缀列表功能正在邀测中,暂不支持本次操作。

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