ListLists - 列举自定义列表

更新时间: 2024-12-26 17:03:21

列举账户下所有自定义的列表以及它们的详细信息,可以通过传入的查询参数进行筛选,以及进行分页处理来获取特定的列表集合。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
esa:ListListslist
*全部资源
*

请求参数

名称类型必填描述示例值
QueryArgsobject

查询参数,以 JSON 格式传递,包含各种筛选条件。

IdLikestring

模糊查询列表 ID。

40000001
NameLikestring

模糊查询列表名称。

example
DescriptionLikestring

模糊查询列表描述。

a custom list
ItemLikestring

模糊查询列表内容。

10.1.1.1
NameItemLikestring

同时模糊查询列表内容和名称。

10.1.1.1
Kindstring

自定义列表种类。

ip
OrderBystring

指定排序的列。

id
Descboolean

是否倒序排列。

true
PageNumberinteger

页面号码,用于指定分页查询的页码。

1
PageSizeinteger

页面大小,用于指定分页查询的每页数量。

20

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

36af3fcc-43d0-441c-86b1-428951dc8225
TotalCountinteger

过滤后总记录数。

5
Usagelong

用户已使用量。

10
Listsarray<object>

列表信息数组,包含分页后的列表数据。

Listobject

列表信息。

UpdateTimestring

列表的最后修改时间。

2024-01-01T00:00:00Z
Idlong

自定义列表的 ID,可通过调用 ListLists 接口获取。

40000001
Namestring

列表名称。

example
Kindstring

列表种类。

ip
Descriptionstring

列表描述。

a custom list
Lengthlong

列表内容数组长度,表示列表包含多少项。

100
PageNumberinteger

当前页码。

1
PageSizeinteger

每页大小。

20

示例

正常返回示例

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错误码错误信息描述
400InvalidParameterThe specified parameter is invalid.输入参数规范校验失败。
400InternalExceptionFailed to call the service. Try again later or contact technical support.调用服务失败,请稍后重试或联系客服咨询详情。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-09-25OpenAPI 错误码发生变更查看变更详情
2024-09-18OpenAPI 错误码发生变更查看变更详情
上一篇: DeleteList - 删除自定义列表 下一篇: GetList - 获取单个自定义列表详情