創建自定義錯誤響應頁面。當用戶的請求被Web應用防火墻(WAF)阻斷時,可以展示這些自定義的錯誤頁面。用戶可以配置頁面HTML內容、頁面類型、描述等信息,并通過BASE64編碼方式提交頁面內容。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
esa:CreatePage | create | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Name | string | 是 | 自定義頁面的名稱。 | example |
Description | string | 否 | 頁面的描述信息。 | a custom deny page |
ContentType | string | 是 | 指定 HTTP Header 中的 Content-Type 字段,例如:
| text/html |
Content | string | 否 | BASE64 編碼后的頁面內容。 示例值: "PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4=" (表示 "hello page") | PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4= |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "36af3fcc-43d0-441c-86b1-428951dc8225",
"Id": 50000001
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | InvalidParameter | The specified parameter is invalid. | 輸入參數規范校驗失敗。 |
400 | InternalException | Failed to call the service. Try again later or contact technical support. | 調用服務失敗,請稍后重試或聯系客服咨詢詳情。 |
403 | %s.NotSupport | The specified resource type %s is not supported. | 不支持指定的資源類型。如需使用該類型資源,請與我們聯系。 |
403 | %s.OverQuota | The quantity of %s exceeds the quota. | 該資源的數量超出了配額所規定的范圍,如需申請更多的額度,請與我們聯系。 |
403 | %s.WrongValueMatched | The value of specified parameter %s can not pass the matching check. | 指定的參數對應的值不能通過匹配校驗。如果您確定需要使用該參數值,請與我們聯系。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-09-25 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-09-18 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |