All Products
Search
Document Center

AnalyticDB:GetLakeStorage

Last Updated:Nov 10, 2025

Queries a lake storage.

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:
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
adb:GetLakeStorageget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The region ID.

cn-hangzhou
LakeStorageIdstringNo

The lake storage ID.

-
DBClusterIdstringNo

The cluster ID.

amv-*******

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

******-3EEC-******-9F06-******
Dataobject

The queried lake storage.

LakeStorageIdstring

The unique identifier of the lake storage.

-
Descriptionstring

The description of the lake storage.

a test db
DBClusterIdstring

The ID of the AnalyticDB for MySQL cluster.

amv-*******
FileSizestring

The total storage size.

1
RowCountlong

The total number of entries returned.

-
TableCountinteger

The number of the tables.

-
PartitionCountstring

The number of partitions.

-
CreatorUidstring

The creator UID.

123456
OwnerUidstring

The owner UID.

123456
OperatorUidstring

The operator UID.

123456
Permissionsarray<object>

The permissions on the lake storage.

-
Permissionsobject

The permissions.

Readboolean

The read permissions.

true
Writeboolean

The write permissions.

true
Accountstring

The account ID.

test
Typestring

The account type.

-
CreateTimestring

The time when the lake storage was created.

2023-05-15T07:24:58Z
UpdateTimestring

The time when the lake storage was last updated.

2024-10-14T02:28:41Z
RegionIdstring

The region ID.

cn-hangzhou
HttpStatusCodeinteger

The response code. The status code 200 indicates that the request was successful.

200
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
Codestring

The HTTP status code or the error code.

200
Messagestring

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": "******-3EEC-******-9F06-******",
  "Data": {
    "LakeStorageId": "-",
    "Description": "a test db",
    "DBClusterId": "amv-*******",
    "FileSize": 1,
    "RowCount": 0,
    "TableCount": 0,
    "PartitionCount": "-",
    "CreatorUid": 123456,
    "OwnerUid": 123456,
    "OperatorUid": 123456,
    "Permissions": [
      {
        "Read": true,
        "Write": true,
        "Account": "test",
        "Type": "-"
      }
    ],
    "CreateTime": "2023-05-15T07:24:58Z",
    "UpdateTime": "2024-10-14T02:28:41Z",
    "RegionId": "cn-hangzhou"
  },
  "HttpStatusCode": 200,
  "Success": true,
  "Code": 200,
  "Message": "SUCCESS"
}

Error codes

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