ListPrefixLists - 查询前缀列表的列表信息

更新时间:
复制 MD 格式

调用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 个前缀列表。

pl-m5estsqsdqwg88hjf****

string

否

前缀列表的实例 ID。

pl-0b7hwu67****

NextToken

string

否

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。

  • 如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。

FFmyTO70tTpLG6I3FmYAXGKPd****

MaxResults

integer

否

分批次查询时每次显示的条目数。取值范围:1~100,默认值为 20。

20

ResourceGroupId

string

否

前缀列表所属的资源组 ID。

rg-bp67acfmxazb4ph****

Tags

array<object>

否

标签列表。

object

否

标签列表。

Key

string

否

资源的标签键。最多支持输入 20 个标签键。如需传入该值,则不能输入空字符串。

一个标签键最多支持 128 个字符,不能以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

integer

查询到的列表数目。

1

MaxResults

integer

分批次查询时每次显示的条目数。取值范围:1~100,默认值为 20。

20

PrefixLists

array<object>

查询到的前缀列表的列表信息。

array<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

前缀列表的创建时间。时间按照 ISO 8601 标准表示,使用 UTC 时间,格式为 YYYY-MM-DDThh:mm:ssZ。

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

array<object>

标签列表。

object

标签列表。

Key

string

标签键。

FinanceDept

Value

string

标签值。

FinanceJoshua

PrefixListType

string

前缀列表类型

Custom

示例

正常返回示例

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"
        }
      ],
      "PrefixListType": "Custom"
    }
  ]
}

错误码

HTTP status code

错误码

错误信息

描述

400 IllegalParam.NextToken The specified NextToken is invalid. 参数NextToken非法.

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

变更历史

更多信息,参考变更详情。