All Products
Search
Document Center

AnalyticDB:DescribeInclinedTables

Last Updated:Nov 10, 2025

Queries the information about skewed tables for an AnalyticDB for MySQL cluster.

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:DescribeInclinedTablesget
*DBClusterLakeVersion
acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The cluster ID.

Note You can call the DescribeDBClusters operation to query the information about all AnalyticDB for MySQL Data Lakehouse Edition clusters within a region, including cluster IDs.
amv-k2jofo4pi5zhd****
TableTypestringYes

The type of the table. Valid values:

  • FactTable: the partitioned table.
  • DimensionTable: the dimension table.
FactTable
OrderstringNo

The order by which to sort query results. Specify the parameter value in the JSON format.

Example:

[

    {

        "Field":"Name",

        "Type":"Asc"

    }

]

Field specifies the field by which to sort the query results. Set the value to Name. Type specifies the sorting order. Valid values: Desc and Asc.

Field and Type are case-insensitive.

[ { "Field":"Name", "Type":"Asc" } ]
PageSizeintegerNo

The number of entries per page. Valid values:

  • 30 (default)
  • 50
  • 100
30
PageNumberintegerNo

The page number. Pages start from page 1.

1
RegionIdstringNo

The region ID.

Note You can call the DescribeRegions operation to query the most recent region list.
cn-hongkong
LangstringNo

The language. Valid values:

  • zh (default): simplified Chinese.
  • en: English.
  • ja: Japanese.
  • zh-tw: traditional Chinese.
zh

Response parameters

ParameterTypeDescriptionExample
object
TotalCountstring

The total number of entries returned.

15
PageSizestring

The total number of pages.

30
RequestIdstring

The request ID.

1AD222E9-E606-4A42-BF6D-8A4442913CEF
PageNumberstring

The page number. Pages start from page 1.

1
Itemsobject

The queried tables.

Tablearray<object>

The queried table.

SkewedTablesobject

The information about the table.

Typestring

The detection type of the table.

Fact
Schemastring

The name of the database.

spark_test
Sizelong

The number of rows in the table.

200
Namestring

The name of the table.

admin_daily_own_statistic_record
IsInclineboolean

Indicates whether data is skewed in the table.

True
TotalSizelong

The total data size of the table. Unit: bytes.

Note The following formulas can be used to calculate the total data size:
  • Formula 1: Total data size = Hot data size + Cold data size.
  • Formula 2: Total data size = Data size of table records + Data size of regular indexes + Data size of primary key indexes + Data size of other data.
53687091200
SpaceRatiodouble

The percentage of the table size. Unit: %.

Note Formula: Table storage percentage = Total data size of a table/Total data size of the cluster × 100%.
0.4
RowCountlong

The number of rows in the table.

1000
DetectionItemsarray<object>

The queried detection items and detection results.

Itemsobject

The detection result.

Namestring

The name of the detection item.

Table skew
Messagestring

The message of the detection result.

A shard skew is detected in a table.
Statusstring

The severity level of the detection result.

NORMAL WARNNING CRITICAL
AccessDeniedDetailstring

The details about the access denial. This parameter is returned only if Resource Access Management (RAM) permission verification failed.

{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "1*****************7", "EncodedDiagnosticMessage": "AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "2***************9", "NoPermissionType": "ImplicitDeny", "AuthAction": "adb:DescribeExcessivePrimaryKeys" }

Examples

Sample success responses

JSONformat

{
  "TotalCount": 15,
  "PageSize": 30,
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "PageNumber": 1,
  "Items": {
    "Table": [
      {
        "Type": "Fact",
        "Schema": "spark_test",
        "Size": 200,
        "Name": "admin_daily_own_statistic_record",
        "IsIncline": true,
        "TotalSize": 53687091200,
        "SpaceRatio": 0.4,
        "RowCount": 1000
      }
    ]
  },
  "DetectionItems": [
    {
      "Name": "Table skew",
      "Message": "A shard skew is detected in a table.",
      "Status": "NORMAL\nWARNNING\nCRITICAL"
    }
  ],
  "AccessDeniedDetail": {
    "PolicyType": "AccountLevelIdentityBasedPolicy",
    "AuthPrincipalOwnerId": "1*****************7",
    "EncodedDiagnosticMessage": "AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==",
    "AuthPrincipalType": "SubUser",
    "AuthPrincipalDisplayName": "2***************9",
    "NoPermissionType": "ImplicitDeny",
    "AuthAction": "adb:DescribeExcessivePrimaryKeys"
  }
}

Error codes

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