CreatePage - 创建自定义响应页面

更新时间: 2024-12-26 17:01:27

创建自定义错误响应页面。当用户的请求被Web应用防火墙(WAF)阻断时,可以展示这些自定义的错误页面。用户可以配置页面HTML内容、页面类型、描述等信息,并通过BASE64编码方式提交页面内容。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
esa:CreatePagecreate
*全部资源
*

请求参数

名称类型必填描述示例值
Namestring

自定义页面的名称。

example
Descriptionstring

页面的描述信息。

a custom deny page
ContentTypestring

指定 HTTP Header 中的 Content-Type 字段,例如:

  • text/html
  • application/json
text/html
Contentstring

BASE64 编码后的页面内容。 示例值: "PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4=" (表示 "hello page")

PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4=

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

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

自定义响应页面的 ID,可通过调用 ListPages 接口获取。

50000001

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400InvalidParameterThe specified parameter is invalid.输入参数规范校验失败。
400InternalExceptionFailed to call the service. Try again later or contact technical support.调用服务失败,请稍后重试或联系客服咨询详情。
403%s.NotSupportThe specified resource type %s is not supported.不支持指定的资源类型。如需使用该类型资源,请与我们联系。
403%s.OverQuotaThe quantity of %s exceeds the quota.该资源的数量超出了配额所规定的范围,如需申请更多的额度,请与我们联系。
403%s.WrongValueMatchedThe value of specified parameter %s can not pass the matching check.指定的参数对应的值不能通过匹配校验。如果您确定需要使用该参数值,请与我们联系。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-09-25OpenAPI 错误码发生变更查看变更详情
2024-09-18OpenAPI 错误码发生变更查看变更详情
上一篇: 全局配置 下一篇: DeletePage - 删除自定义响应页面