ListPages - List custom response pages - Edge Security Acceleration

Lists all custom response pages created by the user. This operation supports pagination and allows you to retrieve the response page list by specifying the page number and page size.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

esa:ListPages

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
QueryArgs	object	No	The query parameters passed in JSON format, which contain various filter conditions.
NameDescriptionLike	string	No	The keyword used for fuzzy matching against the name or description of custom pages.	example
ContentType	string	No	The Content-Type field in the HTTP header. Example values: text/html application/json	application/json
PageNumber	integer	No	The page number. Valid values: 1 to 100000. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 20.	20

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	36af3fcc-43d0-441c-86b1-428951dc8225
Usage	integer	The number of custom response pages created by the user.	10
TotalCount	integer	The number of custom response pages after filtering.	10
Pages	array<object>	The array of custom response pages. Each object in the array contains the details of a page.
	object	WafPageItemType
UpdateTime	string	The time when the custom response page was last modified. Format: RFC 3339 / ISO 8601, UTC time zone (ending with Z). Example: 2026-06-10T14:23:45Z	2024-01-01T00:00:00Z
Id	integer	The ID of the custom response page. You can call the ListPages operation to obtain the ID.	50000001
Name	string	The name of the custom response page.	example
Kind	string	The type of the custom response page.	custom
Description	string	The description of the custom response page.	a custom deny page
ContentType	string	The Content-Type field in the HTTP header.	text/html
Content	string	The Base64-encoded response page content corresponding to the Content-Type.	PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4=
PageNumber	integer	The current page number.	1
PageSize	integer	The number of entries per page.	20

Examples

Success response

JSON format

{
  "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
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter is invalid.	The specified parameter is invalid.
400	InternalException	Failed to call the service. Try again later or contact technical support.	Failed to call the service. Try again later or contact technical support.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.