All Products
Search
Document Center

Edge Security Acceleration:ListLists

Last Updated:Dec 26, 2024

Queries all custom lists and their details in an Alibaba Cloud account. You can specify query arguments to filter the results and display the returned lists by page.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
esa:ListListslist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
QueryArgsobjectNo

The query arguments in the JSON format, which contain filter conditions.

IdLikestringNo

The list ID for fuzzy search.

40000001
NameLikestringNo

The list name for fuzzy search.

example
DescriptionLikestringNo

The list description for fuzzy search.

a custom list
ItemLikestringNo

The list content for fuzzy search.

10.1.1.1
NameItemLikestringNo

The list name and content for fuzzy search.

10.1.1.1
OrderBystringNo

The column by which you want to sort the returned data.

id
DescbooleanNo

Specifies whether to sort the returned data in descending order.

true
PageNumberintegerNo

The page number.

1
PageSizeintegerNo

The number of entries per page.

20

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

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

The total number of filtered lists.

5
Usagelong

The number of created lists.

10
Listsarray<object>

The array that contains list information, including list data after paging.

Listobject

The list information.

UpdateTimestring

The time when the list was last modified.

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

The ID of the custom list.

40000001
Namestring

The list name.

example
Kindstring

The list type.

ip
Descriptionstring

The list description.

a custom list
Lengthlong

The length of the list information array, which indicates how many items the list contains.

100
PageNumberinteger

The page number returned.

1
PageSizeinteger

The number of entries per page.

20

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameterThe specified parameter is invalid.The specified parameter is invalid.
400InternalExceptionFailed to call the service. Try again later or contact technical support.Failed to call the service. Try again later or contact technical support.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-09-25The Error code has changedView Change Details
2024-09-18The Error code has changedView Change Details