All Products
Search
Document Center

AnalyticDB:DescribeInclinedTables

Last Updated:May 23, 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
DBCluster
acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The ID of the AnalyticDB for MySQL Data Warehouse Edition cluster.

am-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
  • 50
  • 100

Default value: 30.

30
PageNumberintegerNo

The page number. Pages start from page 1. Default value: 1.

1
RegionIdstringNo

The region ID.

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

The language in which you want to send requests and receive messages. Default value: zh. Valid values:

  • zh: Chinese.
  • en: English.
zh

Response parameters

ParameterTypeDescriptionExample
object
TotalCountstring

The total number of entries returned.

15
PageSizestring

The number of entries per page.

30
RequestIdstring

The request ID.

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

The page number.

1
Itemsobject

The queried tables.

Tablearray<object>

The queried table.

Itemsobject

The information about the table.

Typestring

The column type.

executor
Schemastring

The name of the database.

adm_analyze
Sizestring

The number of rows in the table.

2416527
Namestring

The name of the table.

ff
IsInclinestring

Indicates whether data is skewed in the table.

true
TotalSizelong

The total data size of the table.

65
SpaceRatiodouble

The percentage of the table size.

89
RowCountlong

The number of rows in the table.

2565
DetectionItemsarray<object>

The queried detection items and detection results.

Itemsobject

The queried detection item and detection result.

Namestring

The name of the detection item.

Excessive primary key fields
Messagestring

The message of the detection result.

There are a total of 10 tables with an excessive number of primary keys.
Statusstring

The severity level of the detection result. Valid values:

  • NORMAL
  • WARNING
  • CRITICAL
WARNING

Examples

Sample success responses

JSONformat

{
  "TotalCount": 15,
  "PageSize": 30,
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "PageNumber": 1,
  "Items": {
    "Table": [
      {
        "Type": "executor",
        "Schema": "adm_analyze",
        "Size": 2416527,
        "Name": "ff",
        "IsIncline": true,
        "TotalSize": 65,
        "SpaceRatio": 89,
        "RowCount": 2565
      }
    ]
  },
  "DetectionItems": [
    {
      "Name": "Excessive primary key fields",
      "Message": "There are a total of 10 tables with an excessive number of primary keys.",
      "Status": "WARNING"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.
500InternalFailureAn error occurred while processing your request.An internal error has occurred. Please try again later.

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

Change history

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