列舉賬戶下所有自訂的列表以及它們的詳細資料,可以通過傳入的查詢參數進行篩選,以及進行分頁處理來擷取特定的列表集合。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
esa:ListLists |
list |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| QueryArgs |
object |
否 |
查詢參數,以 JSON 格式傳遞,包含各種篩選條件。 |
ListLists |
| IdLike |
string |
否 |
模糊查詢列表 ID。 |
40000001 |
| NameLike |
string |
否 |
模糊查詢列表名稱。 |
example |
| DescriptionLike |
string |
否 |
模糊查詢列表描述。 |
a custom list |
| ItemLike |
string |
否 |
模糊查詢列表內容。 |
10.1.1.1 |
| NameItemLike |
string |
否 |
同時模糊查詢列表內容和名稱。 |
10.1.1.1 |
| Kind |
string |
否 |
自訂欄表種類。 |
ip |
| OrderBy |
string |
否 |
指定排序的列。 |
id |
| Desc |
boolean |
否 |
是否倒序排列。 |
true |
| PageNumber |
integer |
否 |
頁面號碼,用於指定分頁查詢的頁碼。 |
1 |
| PageSize |
integer |
否 |
頁面大小,用於指定分頁查詢的每頁數量。 |
20 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
Schema of Response |
||
| RequestId |
string |
請求 ID。 |
36af3fcc-43d0-441c-86b1-428951dc8225 |
| TotalCount |
integer |
過濾後總記錄數。 |
5 |
| Usage |
integer |
使用者已使用量。 |
10 |
| Lists |
array<object> |
列表資訊數組,包含分頁後的列表資料。 |
|
|
object |
列表資訊。 |
||
| UpdateTime |
string |
列表的最後修改時間。 |
2024-01-01T00:00:00Z |
| Id |
integer |
自訂欄表的 ID,可通過調用 ListLists 介面擷取。 |
40000001 |
| Name |
string |
列表名稱。 |
example |
| Kind |
string |
列表種類。 |
ip |
| Description |
string |
列表描述。 |
a custom list |
| Length |
integer |
列表內容數組長度,表示列表包含多少項。 |
100 |
| PageNumber |
integer |
當前頁碼。 |
1 |
| PageSize |
integer |
每頁大小。 |
20 |
| ItemsUsage |
integer |
item 總使用量。 |
5000 |
樣本
正常返回樣本
JSON格式
{
"RequestId": "36af3fcc-43d0-441c-86b1-428951dc8225",
"TotalCount": 5,
"Usage": 10,
"Lists": [
{
"UpdateTime": "2024-01-01T00:00:00Z",
"Id": 40000001,
"Name": "example",
"Kind": "ip",
"Description": "a custom list",
"Length": 100
}
],
"PageNumber": 1,
"PageSize": 20,
"ItemsUsage": 5000
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InvalidParameter | The specified parameter is invalid. | 輸入參數規範校正失敗。 |
| 400 | InternalException | Failed to call the service. Try again later or contact technical support. | 調用服務失敗,請稍後重試或聯絡客服諮詢詳情。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。