ListPages - 列举自定义响应页面

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
QueryArgsobject

查询参数,以 JSON 格式传递,包含各种筛选条件。

NameDescriptionLikestring

模糊查询自定义页面的名称或者描述。

example
PageNumberinteger

页面号码,取值范围为:1~100000,默认 1。

1
PageSizeinteger

页面大小,默认 20。

20

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

36af3fcc-43d0-441c-86b1-428951dc8225
Usagelong

用户已创建的自定义响应页面的数量。

10
TotalCountinteger

过滤后的自定义响应页面数量。

10
Pagesarray<object>

自定义响应页面数组。数组中的每个对象包含页面的具体信息。

Pageobject

WafPageItemType

UpdateTimestring

自定义响应页面的最后修改时间。

2024-01-01T00:00:00Z
Idlong

自定义响应页面的 ID,可通过调用 ListPages 接口获取。

50000001
Namestring

自定义响应页面的名称。

example
Kindstring

自定义响应页面的类型。

custom
Descriptionstring

自定义响应页面描述。

a custom deny page
ContentTypestring

HTTP Header 中的 Content-Type 字段。

text/html
Contentstring

BASE64 编码后的 Content-Type 对应的响应页面内容。

PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4=
PageNumberinteger

当前页码。

1
PageSizeinteger

每页大小。

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错误码错误信息描述
400InvalidParameterThe specified parameter is invalid.输入参数规范校验失败。
400InternalExceptionFailed to call the service. Try again later or contact technical support.调用服务失败,请稍后重试或联系客服咨询详情。

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

变更历史

变更时间变更内容概要操作
2025-01-09OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2024-09-25OpenAPI 错误码发生变更查看变更详情
2024-09-18OpenAPI 错误码发生变更查看变更详情