ListLists - Query custom lists | ESA API - Edge Security Acceleration

Lists all custom lists under the account along with their details. You can use query parameters to filter results and paginate to retrieve a specific set of lists.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

esa:ListLists

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
QueryArgs	object	No	The query parameters passed in JSON format, which contain various filter conditions.	ListLists
IdLike	string	No	The value used to fuzzy match list IDs.	40000001
NameLike	string	No	The value used to fuzzy match list names.	example
DescriptionLike	string	No	The value used to fuzzy match list descriptions.	a custom list
ItemLike	string	No	The value used to fuzzy match list content.	10.1.1.1
NameItemLike	string	No	The value used to fuzzy match both list content and list names simultaneously.	10.1.1.1
Kind	string	No	The kind of the custom list.	ip
OrderBy	string	No	The column by which to sort the results.	id
Desc	boolean	No	Specifies whether to sort the results in descending order.	true
PageNumber	integer	No	The page number for paging.	1
PageSize	integer	No	The number of entries per page for paging.	20

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	36af3fcc-43d0-441c-86b1-428951dc8225
TotalCount	integer	The total number of records after filtering.	5
Usage	integer	The amount of usage consumed by the user.	10
Lists	array<object>	The array of list information, which contains the paginated list data.
	object	The list information.
UpdateTime	string	The time when the list was last modified. Format: RFC 3339 / ISO 8601, UTC time zone (ending with Z). Example: 2026-06-10T14:23:45Z	2024-01-01T00:00:00Z
Id	integer	The ID of the custom list. You can obtain the ID by calling the ListLists operation.	40000001
Name	string	The list name.	example
Kind	string	The kind of the list.	ip
Description	string	The list description.	a custom list
Length	integer	The length of the list content array, which indicates the number of items in the list.	100
PageNumber	integer	The current page number.	1
PageSize	integer	The number of entries per page.	20
ItemsUsage	integer	The total item usage.	5000

Examples

Success response

JSON format

{
  "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
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter is invalid.	The specified parameter is invalid.
400	InternalException	Failed to call the service. Try again later or contact technical support.	Failed to call the service. Try again later or contact technical support.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.