Configure Custom Error Pages via UpdatePage API - Edge Security Acceleration - Alibaba Cloud - 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:UpdatePage

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Id	integer	Yes	The ID of the custom response page. You can obtain this value by calling the ListPages operation.	50000001
Name	string	Yes	The name of the custom response page after the update. Naming suggestion: Use a combination of letters, digits, and underscores (such as `blocked_page_v2`) for easy reference in rules. The character set, maximum length, and uniqueness constraints are subject to the server-side naming conventions for custom pages. If this parameter is not specified, the original name is retained.	example
Description	string	Yes	The description of the page after the update. This is used to identify the purpose of the page in the console list. This is an optional field. If this parameter is not specified, the original description is retained. The maximum field length is subject to the server-side limit.	a custom deny page
ContentType	string	Yes	The MIME type of the page content, which is returned to the client as the HTTP `Content-Type` response header when a rule is matched. Common values: `text/html`: HTML page `application/json`: JSON response Note The complete set of supported values is subject to the server-side specification. The actual format of `Content` must match this field. A mismatch may cause browser rendering issues.	text/html
Content	string	Yes	The BASE64-encoded page content, which must be consistent with `ContentType`. Encoding method: Convert the original page content to a UTF-8 byte string. Encode the byte string using standard BASE64 encoding. Example: `<html>hello page</html>` → `PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4=` Note The maximum size limit is subject to the server-side custom page specification. If this parameter is not specified, the original page content is retained.	PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4=
SiteIds	array	No	The list of site IDs associated with this page after the update. This parameter uses full overwrite semantics. You can obtain site IDs by calling the `ListSites` operation. Passing an empty list dissociates all sites from the page. Including a site ID that does not belong to your account returns an `InvalidParameter` error.
	integer	No	The associated site ID.	1

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	36af3fcc-43d0-441c-86b1-428951dc8225

Examples

Success response

JSON format

{
  "RequestId": "36af3fcc-43d0-441c-86b1-428951dc8225"
}

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.
403	%s.NotSupport	The specified resource type %s is not supported.	The specified resource type is not supported. To use this type of resource, please contact us.
403	%s.OverQuota	The quantity of %s exceeds the quota.	The amount of this resource exceeds the quota. If you need to apply for more quota, please contact us.
403	%s.WrongValueMatched	The value of specified parameter %s can not pass the matching check.	The value of the specified parameter can not pass the matching check. If you determine that you need to use this parameter value, please contact us.
403	Page.NotExist	The specified custom error page does not exist or is not recognized by the system.Check whether the error page identifier is correct and matches an error page that has been created and registered in the system's error handling framework.If you want to create a new error page, make sure that the creation process is complete.	The specified custom error page does not exist or is not recognized by the system.Check whether the error page identifier is correct and matches an error page that has been created and registered in the system's error handling framework.If you want to create a new error page, make sure that the creation process is complete.
403	Page.SiteAlreadyBound	The specified site has already been associated with another custom error page of the same type. Dissociate the site from the existing page and try again.	The specified site is already bound to another custom response page of the same type. Please first unbind the site from the existing page and then try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.