All Products
Search
Document Center

Edge Security Acceleration:ListPages

Last Updated:Nov 07, 2025

Lists all custom error pages that you created. You can define the page number and the number of entries per page to display the response.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
esa:ListPageslist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PageNumberintegerNo

The page number. Valid values: 1 to 100000. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Default value: 20.

20

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

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

The number of custom error pages that you created.

10
TotalCountinteger

The number of custom error pages after filtering.

10
Pagesarray<object>

The custom error pages. Each element in the array contains error page-specific information.

Pageobject

WafPageItemType

UpdateTimestring

The time when the custom error page was last modified.

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

The ID of the custom error page.

50000001
Namestring

The name of the custom error page.

example
Kindstring

The type of the custom error page.

custom
Descriptionstring

The description of the custom error page.

a custom deny page
ContentTypestring

The Content-Type field in the HTTP header.

text/html
Contentstring

The Base64-encoded content of the error page. The content type is specified by the Content-Type field.

PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4=
PageNumberinteger

The page number returned.

1
PageSizeinteger

The number of entries per page.

20

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400InvalidParameterThe specified parameter is invalid.The specified parameter is invalid.
400InternalExceptionFailed to call the service. Try again later or contact technical support.Failed to call the service. Try again later or contact technical support.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2025-01-09The Error code has changed. The request parameters of the API has changedView Change Details
2024-09-25The Error code has changedView Change Details
2024-09-18The Error code has changedView Change Details