All Products
Search
Document Center

AnalyticDB for MySQL:DescribeTableStatistics

Last Updated:Mar 15, 2024

Operation description

Note For more information about table statistics, see View monitoring information of resource pools.

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
adb:DescribeTableStatisticsRead
  • DBCluster
    acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The ID of the cluster.

Note You can call the DescribeDBClusters operation to query details about all AnalyticDB for MySQL clusters in a specific region, including cluster IDs.
am-****************
PageSizeintegerNo

The number of entries to return on each page. Valid values: 30, 50, and 100. Default value: 30.

30
PageNumberintegerNo

The number of the page to return. The value must be an integer that is greater than 0. Default value: 1.

1
OrderstringNo

The order in which to sort the retrieved records by field. Specify this value in the JSON format. The value is an ordered array that uses the order of the input array and contains Field and Type. Example: [{ "Field":"TableName", "Type":"Asc" }].

  • In the example, Field indicates the field that is used to sort the retrieved records. Set the value of Field to TableName.

  • Type indicates the sort type. Valid values (case-insensitive):

    • Desc: The entries are sorted in descending order.
    • Asc: The entries are sorted in ascending order.
[ { "Field":"TableName", "Type":"Asc" } ]
RegionIdstringNo

The region ID of the cluster.

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

Response parameters

ParameterTypeDescriptionExample
object
TotalCountstring

The total number of entries.

1
PageSizestring

The number of entries returned on the current page.

30
RequestIdstring

The ID of the request.

4C4433FF-5D3A-4C3E-A19C-6D93B2******
PageNumberstring

The page number of the returned page.

1
DBClusterIdstring

The ID of the cluster.

am-****************
Itemsobject []

Details about table statistics.

SchemaNamestring

The name of the database.

test_schema
TableNamestring

The name of the table.

test_table
RowCountlong

The number of rows in the table.

3
DataSizelong

The amount of data in the table. Unit: byte.

15592
IndexSizelong

The amount of data in indexes. Unit: byte.

3076
PrimaryKeyIndexSizelong

The amount of data in primary key indexes. Unit: byte.

16340
PartitionCountlong

The number of partitions.

1
ColdDataSizelong

The total amount of cold data. Unit: byte.

Note The parameter is returned only when the engine version of the cluster is 3.1.3.4 or later.
0

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
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-03-14The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2024-02-20The request parameters of the API has changed. The response structure of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: Keyword
Output ParametersThe response structure of the API has changed.