DescribePrefixLists - 查询前缀列表 - 云防火墙

查询前缀列表。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
yundun-cloudfirewall:DescribePrefixLists	list	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
SourceIp	string	否	访问者源 IP 地址。	47.100.XX.XX
RegionNo	string	是	实例所在的地域 ID。	cn-shenzhen

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	返回结果的请求 ID。	67FD76C2-C493-5815-8107-643FD7AB77C7
PrefixList	array<object>	前缀列表信息组成的数组。
Data	object	前缀列表信息组成的数组。
PrefixListId	string	前缀列表 ID。	pl-uf64nco3ujjqchx6aaji
PrefixListName	string	前缀列表的名称。	participant-name
Description	string	描述。	TCP_14900-14911
CreationTime	string	创建时间。	2023-10-16T08:31:06Z
AssociationCount	integer	关联资源的数量。	2
MaxEntries	integer	前缀列表支持的最大条目容量。	20
AddressFamily	string	前缀列表的地址族。可能值： IPv4。 IPv6。	IPv4

示例

正常返回示例

JSON格式

{
  "RequestId": "67FD76C2-C493-5815-8107-643FD7AB77C7",
  "PrefixList": [
    {
      "PrefixListId": "pl-uf64nco3ujjqchx6aaji",
      "PrefixListName": "participant-name",
      "Description": "TCP_14900-14911",
      "CreationTime": "2023-10-16T08:31:06Z",
      "AssociationCount": 2,
      "MaxEntries": 20,
      "AddressFamily": "IPv4"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	ErrorParameters	parameters invalid.	参数错误，请检查后重试。
400	ErrorMarshalJSON	An error occurred while encoding JSON.	内部错误：JSON编码错误

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

变更历史

变更时间	变更内容概要	操作
2024-09-05	OpenAPI 错误码发生变更	查看变更详情