使用ListPages分页查询自定义响应页面-边缘安全加速-阿里云

列举用户已创建的所有自定义响应页面。该接口提供了分页功能，支持根据页码和页大小获取响应页面列表。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

esa:ListPages

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
QueryArgs	object	否	查询参数，以 JSON 格式传递，包含各种筛选条件。
NameDescriptionLike	string	否	模糊查询自定义页面的名称或者描述。	example
PageNumber	integer	否	页面号码，取值范围为：1~100000，默认 1。	1
PageSize	integer	否	页面大小，默认 20。	20

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	36af3fcc-43d0-441c-86b1-428951dc8225
Usage	integer	用户已创建的自定义响应页面的数量。	10
TotalCount	integer	过滤后的自定义响应页面数量。	10
Pages	array<object>	自定义响应页面数组。数组中的每个对象包含页面的具体信息。
	object	WafPageItemType
UpdateTime	string	自定义响应页面的最后修改时间。	2024-01-01T00:00:00Z
Id	integer	自定义响应页面的 ID，可通过调用 ListPages 接口获取。	50000001
Name	string	自定义响应页面的名称。	example
Kind	string	自定义响应页面的类型。	custom
Description	string	自定义响应页面描述。	a custom deny page
ContentType	string	HTTP Header 中的 Content-Type 字段。	text/html
Content	string	BASE64 编码后的 Content-Type 对应的响应页面内容。	PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4=
PageNumber	integer	当前页码。	1
PageSize	integer	每页大小。	20

示例

正常返回示例

JSON格式

{
  "RequestId": "36af3fcc-43d0-441c-86b1-428951dc8225",
  "Usage": 10,
  "TotalCount": 10,
  "Pages": [
    {
      "UpdateTime": "2024-01-01T00:00:00Z",
      "Id": 50000001,
      "Name": "example",
      "Kind": "custom",
      "Description": "a custom deny page",
      "ContentType": "text/html",
      "Content": "PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4="
    }
  ],
  "PageNumber": 1,
  "PageSize": 20
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter	The specified parameter is invalid.	输入参数规范校验失败。
400	InternalException	Failed to call the service. Try again later or contact technical support.	调用服务失败，请稍后重试或联系客服咨询详情。

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

变更历史

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