DescribeTableStatistics - AnalyticDB for MySQL - Alibaba Cloud Documentation Center

Queries the information about table statistics for an AnalyticDB for MySQL cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
- The required resource types are displayed in bold characters.
- 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:DescribeTableStatistics	Read	DBCluster acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID. Note You can call the DescribeDBClusters operation to query a list of cluster IDs.	am-****************
PageSize	integer	No	The number of entries per page. Valid values: 30 (default) 50 100	30
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
Order	string	No	The order in which to sort the queried information. Specify this parameter as an ordered JSON array that consists of the `Field` and `Type` fields. Example: `[{ "Field":"TableName", "Type":"Asc" }]`. `Field` specifies the field that is used to sort the queried information. The following fields are supported: `TableName`, ColdDataSize, DataSize, PrimaryKeyIndexSize, RowCount, IndexSize, SchemaName, and PartitionCount. `Type` specifies the sorting order. Valid values (case-insensitive): Desc: descending order. Asc: ascending order.	[ { "Field":"TableName", "Type":"Asc" } ]
RegionId	string	No	The region ID of the cluster. Note You can call the DescribeRegions operation to query the most recent region list.	cn-beijing
Keyword	string	No	The keyword that is used to query information by table name.	you_table_name

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
TotalCount	string	The total number of entries returned.	1
PageSize	string	The number of entries per page.	30
RequestId	string	The request ID.	4C4433FF-5D3A-4C3E-A19C-6D93B2******
PageNumber	string	The page number.	1
DBClusterId	string	The cluster ID.	am-****************
Items	object []	The queried table statistics.
SchemaName	string	The name of the database.	test_schema
TableName	string	The name of the table.	test_table
RowCount	long	The number of rows in the table.	3
DataSize	long	The data size of table records. Unit: bytes. Note The data size of table records, excluding the data size of regular index and primary key indexes.	15592
IndexSize	long	The data size of regular indexes. Unit: bytes.	3076
PrimaryKeyIndexSize	long	The data size of primary key indexes. Unit: bytes.	16340
PartitionCount	long	The number of partitions.	1
ColdDataSize	long	The cold data size. Unit: bytes. Note The parameter is returned only for AnalyticDB for MySQL clusters of V3.1.3.4 or later.	0
SpaceRatio	double	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%.	66.23
TotalSize	long	The total data size. 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.	1577
HotDataSize	long	The hot data size. Unit: bytes.	1048576
OtherSize	long	The data size of other data. Unit: bytes.	1048576

Examples

Sample success responses

JSONformat

{
  "TotalCount": "1",
  "PageSize": "30",
  "RequestId": "4C4433FF-5D3A-4C3E-A19C-6D93B2******",
  "PageNumber": "1",
  "DBClusterId": "am-****************",
  "Items": {
    "TableStatisticRecords": [
      {
        "SchemaName": "test_schema",
        "TableName": "test_table",
        "RowCount": 3,
        "DataSize": 15592,
        "IndexSize": 3076,
        "PrimaryKeyIndexSize": 16340,
        "PartitionCount": 1,
        "ColdDataSize": 0,
        "SpaceRatio": 66.23,
        "TotalSize": 1577,
        "HotDataSize": 1048576,
        "OtherSize": 1048576
      }
    ]
  }
}

Error codes

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

Change history

Change time

Summary of changes

Operation

2024-03-14

The internal configuration of the API is changed, but the call is not affected

see changesets

Change item	Change content
	The internal configuration of the API is changed, but the call is not affected.

2024-02-20

The request parameters of the API has changed. The response structure of the API has changed

see changesets

Change item	Change content
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: Keyword
Output Parameters	The response structure of the API has changed.