Custom Error Pages Overview for ESA Edge Policies - Edge Security Acceleration

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:GetPage

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Id	integer	No	The ID of the custom error page, which can be obtained by calling the ListPages operation.	50000001

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	36af3fcc-43d0-441c-86b1-428951dc8225
UpdateTime	string	The time when the custom error page was last modified.	2024-01-01T00:00:00Z
Id	integer	The ID of the custom error page.	50000001
Name	string	The name of the custom response page.	example
Description	string	The description of the custom error page.	a custom deny page
Kind	string	The type of the custom response page.	custom
ContentType	string	The Content-Type field in the HTTP header.	text/html
Content	string	The Base64-encoded content of the error page. The content type is specified by the Content-Type field.	PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4=

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameters	The specified parameters are invalid.	Parameter is illegal.
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.