列举账户下所有自定义的列表以及它们的详细信息,可以通过传入的查询参数进行筛选,以及进行分页处理来获取特定的列表集合。
调试
您可以在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. | 调用服务失败,请稍后重试或联系客服咨询详情。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。