CreatePage - Create a custom error page | ESA API - 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:CreatePage

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Name	string	Yes	The name of the custom page. Naming suggestions: Use a short name that consists of letters, digits, and underscores, such as `blocked_page_v1`, for easy reference in rules. The specific character set, maximum length, uniqueness, and other constraints are subject to the server-side custom page naming specifications.	example
Description	string	No	The description of the page, used to identify the purpose of the page in the console list. Suggested content: Use the scenarios and identity information of the page, such as "CC protection block page - Chinese version". This is an optional field. If not specified, the value is empty by default. Note The maximum field length is subject to the server-side specifications.	a custom deny page
ContentType	string	Yes	The MIME type of the page content. This value is returned to the client as the HTTP `Content-Type` response header after a match. Common values: `text/html`: HTML page. The `Content` parameter must be set to the BASE64-encoded value of UTF-8 HTML text. `application/json`: JSON response. The `Content` parameter must be set to the BASE64-encoded value of a valid JSON string. `text/plain`: plain text. The `Content` parameter must be set to the BASE64-encoded value of plain text content. Note Note: The complete list of supported ContentType values is subject to the server-side specifications. If the specified `ContentType` does not match the actual format of `Content`, the client may fail to render the page properly.	text/html
Content	string	No	The BASE64-encoded page content. The actual content format must match the value of `ContentType`. Encoding method: Encode the original page content into a byte string by using UTF-8 encoding. Apply standard BASE64 encoding to the byte string. Example: Original content: `<html>hello page</html>` BASE64: `PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4=` Note The maximum size, supported character sets, and security filtering rules are subject to the server-side custom page specifications.	PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4=
SiteIds	array	No	The list of website IDs to associate with this custom page. You can obtain website IDs by calling the `ListSites` operation. If you pass an empty list (no websites are associated), the page is still created but does not take effect. You can call the `UpdatePage` operation later to associate websites. If the list contains a website ID that does not belong to the current account, an `InvalidParameter` error is returned.
	integer	No	The associated website ID.	1

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	36af3fcc-43d0-441c-86b1-428951dc8225
Id	integer	The ID of the custom response page. You can obtain the ID by calling the ListPages operation.	50000001

Examples

Success response

JSON format

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

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.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.