列舉賬戶下所有自定義的列表以及它們的詳細信息,可以通過傳入的查詢參數(shù)進行篩選,以及進行分頁處理來獲取特定的列表集合。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產(chǎn)品自身定義的條件關鍵字。
- 關聯(lián)操作:是指成功執(zhí)行操作所需要的其他權限。操作者必須同時具備關聯(lián)操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯(lián)操作 |
---|---|---|---|---|
esa:ListLists | list | *全部資源 * |
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
QueryArgs | object | 否 | 查詢參數(shù),以 JSON 格式傳遞,包含各種篩選條件。 | |
IdLike | string | 否 | 模糊查詢列表 ID。 | 40000001 |
NameLike | string | 否 | 模糊查詢列表名稱。 | example |
DescriptionLike | string | 否 | 模糊查詢列表描述。 | a custom list |
ItemLike | string | 否 | 模糊查詢列表內(nèi)容。 | 10.1.1.1 |
NameItemLike | string | 否 | 同時模糊查詢列表內(nèi)容和名稱。 | 10.1.1.1 |
Kind | string | 否 | 自定義列表種類。 | ip |
OrderBy | string | 否 | 指定排序的列。 | id |
Desc | boolean | 否 | 是否倒序排列。 | true |
PageNumber | integer | 否 | 頁面號碼,用于指定分頁查詢的頁碼。 | 1 |
PageSize | integer | 否 | 頁面大小,用于指定分頁查詢的每頁數(shù)量。 | 20 |
返回參數(shù)
示例
正常返回示例
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
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | InvalidParameter | The specified parameter is invalid. | 輸入?yún)?shù)規(guī)范校驗失敗。 |
400 | InternalException | Failed to call the service. Try again later or contact technical support. | 調(diào)用服務失敗,請稍后重試或聯(lián)系客服咨詢詳情。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-09-25 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
2024-09-18 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |