DescribePrefixListAttributes - 查询指定前缀列表的详细信息 - 云服务器 ECS

调用DescribePrefixListAttributes查询指定前缀列表的详细信息，包含前缀列表的名称、地址族、最大条目容量以及条目的详细信息等。

调试

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

授权信息

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

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

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

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-chengdu
PrefixListId	string	是	前缀列表 ID。	pl-x1j1k5ykzqlixdcy****

返回参数

名称	类型	描述	示例值
	object
CreationTime	string	前缀列表的创建时间。	2021-02-20T07:11Z
MaxEntries	integer	前缀列表支持的最大条目容量。	10
RequestId	string	请求 ID。	38793DB8-A4B2-4AEC-BFD3-111234E9188D
Description	string	前缀列表的描述信息。	This is description.
AddressFamily	string	前缀列表的地址族。可能值： IPv4。 IPv6。	IPv4
PrefixListName	string	前缀列表的名称。	PrefixListNameSample
PrefixListId	string	前缀列表 ID。	pl-x1j1k5ykzqlixdcy****
Entries	array<object>	前缀列表中的条目信息组成的数组。
Entry	object
Description	string	前缀列表条目的描述信息。	Description Sample 01
Cidr	string	前缀列表条目的 CIDR 地址块信息。	192.168.1.0/24

示例

正常返回示例

JSON格式

{
  "CreationTime": "2021-02-20T07:11Z",
  "MaxEntries": 10,
  "RequestId": "38793DB8-A4B2-4AEC-BFD3-111234E9188D",
  "Description": "This is description.",
  "AddressFamily": "IPv4",
  "PrefixListName": "PrefixListNameSample",
  "PrefixListId": "pl-x1j1k5ykzqlixdcy****",
  "Entries": {
    "Entry": [
      {
        "Description": "Description Sample 01",
        "Cidr": "192.168.1.0/24"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
404	InvalidPrefixListId.NotFound	The specified prefix list was not found.	前缀列表不存在。
404	InvalidRegionId.NotFound	The specified RegionId does not exist.	指定的地域 ID 不存在。

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

变更历史

变更时间	变更内容概要	操作
2023-11-13	OpenAPI 错误码发生变更	查看变更详情