Use DescribeInclinedTables to query skewed tables - AnalyticDB - Alibaba Cloud - AnalyticDB

Queries skewed table information for an AnalyticDB for MySQL Data Warehouse Edition cluster.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

adb:DescribeInclinedTables

get

DBCluster

acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID of the AnalyticDB for MySQL Data Warehouse Edition cluster.	am-k2jofo4pi5zhd****
TableType	string	Yes	The type of the table. Valid values: FactTable: the partitioned table. DimensionTable: the dimension table.	FactTable
Order	string	No	The sort order for query results. Specify the value in JSON format. Example: `[ { "Field":"Name", "Type":"Asc" } ]` Field specifies the field to sort by. Set the value to Name. Type specifies the sort order. Valid values: Desc and Asc. Field and Type are case-insensitive.	[ { "Field":"Name", "Type":"Asc" } ]
PageSize	integer	No	The number of entries per page. Valid values: 30 50 100 Default value: 30.	30
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
RegionId	string	No	The region ID. Note You can call the DescribeRegions operation to query the most recent region list.	cn-zhangjiakou
Lang	string	No	The language for requests and responses. Default value: zh. Valid values: zh: Chinese. en: English.	zh

Response elements

Element	Type	Description	Example
	object
TotalCount	string	The total number of entries.	15
PageSize	string	The number of entries per page.	30
RequestId	string	The request ID.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
PageNumber	string	The page number.	1
Items	object	The queried tables.
Table	array<object>	The queried table.
	object	The information about the table.
Type	string	The column type.	executor
Schema	string	The database name.	adm_analyze
Size	string	The row count of the table.	2416527
Name	string	The table name.	ff
IsIncline	string	Indicates whether data skew exists in the table.	true
TotalSize	integer	The total data size of the table.	65
SpaceRatio	number	The percentage of storage space occupied by the table.	89
RowCount	integer	The number of rows in the table.	2565
DetectionItems	array<object>	The detection items and results.
	object	The detection item and result.
Name	string	The detection item name.	Excessive primary key fields
Message	string	The detection result message.	There are a total of 10 tables with an excessive number of primary keys.
Status	string	The severity level. Valid values: NORMAL WARNING CRITICAL	WARNING

Examples

Success response

JSON format

{
  "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 code	Error code	Error message	Description
500	InternalFailure	An error occurred while processing your request.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.