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
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.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
esa:ListLists | list | *All Resources * |
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
QueryArgs | object | No | The query arguments in the JSON format, which contain filter conditions. | |
IdLike | string | No | The list ID for fuzzy search. | 40000001 |
NameLike | string | No | The list name for fuzzy search. | example |
DescriptionLike | string | No | The list description for fuzzy search. | a custom list |
ItemLike | string | No | The list content for fuzzy search. | 10.1.1.1 |
NameItemLike | string | No | The list name and content for fuzzy search. | 10.1.1.1 |
OrderBy | string | No | The column by which you want to sort the returned data. | id |
Desc | boolean | No | Specifies whether to sort the returned data in descending order. | true |
PageNumber | integer | No | The page number. | 1 |
PageSize | integer | No | The number of entries per page. | 20 |
Response parameters
Examples
Sample success responses
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
}
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. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-09-25 | The Error code has changed | View Change Details |
2024-09-18 | The Error code has changed | View Change Details |