列举账户下所有自定义的列表以及它们的详细信息,可以通过传入的查询参数进行筛选,以及进行分页处理来获取特定的列表集合。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
esa:ListLists | list | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
QueryArgs | object | 否 | 查询参数,以 JSON 格式传递,包含各种筛选条件。 | |
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 |
返回参数
示例
正常返回示例
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. | 输入参数规范校验失败。 |
400 | InternalException | Failed to call the service. Try again later or contact technical support. | 调用服务失败,请稍后重试或联系客服咨询详情。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-09-25 | OpenAPI 错误码发生变更 | 查看变更详情 |
2024-09-18 | OpenAPI 错误码发生变更 | 查看变更详情 |