列舉使用者已建立的所有自訂響應頁面。該介面提供了分頁功能,支援根據頁碼和頁大小擷取響應頁面列表。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
esa:ListPages |
list |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| QueryArgs |
object |
否 |
查詢參數,以 JSON 格式傳遞,包含各種篩選條件。 |
|
| NameDescriptionLike |
string |
否 |
模糊查詢自訂頁面的名稱或者描述。 |
example |
| PageNumber |
integer |
否 |
頁面號碼,取值範圍為:1~100000,預設 1。 |
1 |
| PageSize |
integer |
否 |
頁面大小,預設 20。 |
20 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
Schema of Response |
||
| RequestId |
string |
請求 ID。 |
36af3fcc-43d0-441c-86b1-428951dc8225 |
| Usage |
integer |
使用者已建立的自訂響應頁面的數量。 |
10 |
| TotalCount |
integer |
過濾後的自訂響應頁面數量。 |
10 |
| Pages |
array<object> |
自訂響應頁面數組。數組中的每個對象包含頁面的具體資訊。 |
|
|
object |
WafPageItemType |
||
| UpdateTime |
string |
自訂響應頁面的最後修改時間。 |
2024-01-01T00:00:00Z |
| Id |
integer |
自訂響應頁面的 ID,可通過調用 ListPages 介面擷取。 |
50000001 |
| Name |
string |
自訂響應頁面的名稱。 |
example |
| Kind |
string |
自訂響應頁面的類型。 |
custom |
| Description |
string |
自訂響應頁面描述。 |
a custom deny page |
| ContentType |
string |
HTTP Header 中的 Content-Type 欄位。 |
text/html |
| Content |
string |
BASE64 編碼後的 Content-Type 對應的響應頁面內容。 |
PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4= |
| PageNumber |
integer |
當前頁碼。 |
1 |
| PageSize |
integer |
每頁大小。 |
20 |
樣本
正常返回樣本
JSON格式
{
"RequestId": "36af3fcc-43d0-441c-86b1-428951dc8225",
"Usage": 10,
"TotalCount": 10,
"Pages": [
{
"UpdateTime": "2024-01-01T00:00:00Z",
"Id": 50000001,
"Name": "example",
"Kind": "custom",
"Description": "a custom deny page",
"ContentType": "text/html",
"Content": "PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4="
}
],
"PageNumber": 1,
"PageSize": 20
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InvalidParameter | The specified parameter is invalid. | 輸入參數規範校正失敗。 |
| 400 | InternalException | Failed to call the service. Try again later or contact technical support. | 調用服務失敗,請稍後重試或聯絡客服諮詢詳情。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。