ListLakeStorages - AnalyticDB - Alibaba Cloud Documentation Center

Queries a list of lake storages.

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.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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
adb:ListLakeStorages	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
Filter	string	No	The filter parameters that you want to use to query lake storages. Specify multiple parameters in an AND relationship. For example, if you want to query lake storage whose names are in the range of i-a123, or i-b123, and in the Stopped state, set this parameter to &Filter. 1.Name=InstanceName&Filter. 1.Value.1=i-a123&Filter.1.Value.2=i-b123&Filter.2.Name=Status&Filter. 2.Value=Stopped.	-
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page.	30
DBClusterId	string	Yes	The cluster ID.	amv-*******

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	**-964D--9D31-**
TotalCount	integer	The total number of entries returned.	30
PageNumber	integer	The token that is used for paging when the number of results is greater than the value of MaxResults.	1
PageSize	integer	The number of entries per page.	30
Items	array<object>	The queried lake storages.	-
lakeStorage	object	LakeStorageItemType
OwnerUid	string	The queried lake storage.	123456
DBClusterId	string	The ID of the AnalyticDB for MySQL cluster.	amv-*******
TotalRows	long	The total number of entries returned.	30
OperatorUid	string	The operator UID.	123456
Permissions	array<object>	The permissions on the lake storage.	-
Permissions	object	The permissions.
Read	boolean	The read permissions.	true
Write	boolean	The write permissions.	false
Account	string	The database account ID.	-
Type	string	The type of the database account.	-
TableCount	integer	The number of tables.	30
Description	string	The description of the lake storage.	Create a role to run ROS StackGroups.
LakeStorageId	string	The unique identifier of the lake storage.	-
CreateTime	string	The time when the lake storage was created.	2021-04-01T09:50:18Z
TotalStorage	string	The total storage size.	111333
CreatorUid	string	The creator UID.	123456
UpdateTime	string	The time when the lake storage was last updated.	2024-03-15T02:24:32
RegionId	string	The region ID.	cn-hangzhou
FileSize	string	The size of data files.	651
Success	boolean	Indicates whether the dry run succeeds. Valid values: true false	true
HttpStatusCode	integer	The response code. The status code 200 indicates that the request was successful.	200
Code	string	The HTTP status code or the error code.	200
Message	string	The returned message. Valid values: If the request was successful, a success message is returned.**** If the request failed, an error message is returned.	Success

Examples

Sample success responses

JSONformat

{
  "RequestId": "****-964D-****-9D31-****",
  "TotalCount": 30,
  "PageNumber": 1,
  "PageSize": 30,
  "Items": [
    {
      "OwnerUid": 123456,
      "DBClusterId": "amv-*******",
      "TotalRows": 30,
      "OperatorUid": 123456,
      "Permissions": [
        {
          "Read": true,
          "Write": false,
          "Account": "-",
          "Type": "-"
        }
      ],
      "TableCount": 30,
      "Description": "Create a role to run ROS StackGroups.",
      "LakeStorageId": "-",
      "CreateTime": "2021-04-01T09:50:18Z",
      "TotalStorage": 111333,
      "CreatorUid": 123456,
      "UpdateTime": "2024-03-15T02:24:32",
      "RegionId": "cn-hangzhou",
      "FileSize": 651
    }
  ],
  "Success": true,
  "HttpStatusCode": 200,
  "Code": 200,
  "Message": "Success"
}

Error codes

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