DescribeTableStatistics - AnalyticDB for MySQL - Alibaba Cloud Documentation Center

Operation Description

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

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	Association operation
adb:DescribeTableStatistics	Read	ADB acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of the cluster. NoteYou can call the DescribeDBClusters operation to query details about all AnalyticDB for MySQL clusters in a specific region, including cluster IDs.	am-****************
PageSize	integer	No	The number of entries to return on each page. Valid values: 30, 50, and 100. Default value: 30.	30
PageNumber	integer	No	The number of the page to return. The value must be an integer that is greater than 0. Default value: 1.	1
Order	string	No	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" } ]

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	string	The total number of entries.	1
PageSize	string	The number of entries returned on the current page.	30
RequestId	string	The ID of the request.	4C4433FF-5D3A-4C3E-A19C-6D93B2******
PageNumber	string	The page number of the returned page.	1
DBClusterId	string	The ID of the cluster.	am-****************
Items	array	Details about table statistics.
	object
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 amount of data in the table. Unit: byte.	15592
IndexSize	long	The amount of data in indexes. Unit: byte.	3076
PrimaryKeyIndexSize	long	The amount of data in primary key indexes. Unit: byte.	16340
PartitionCount	long	The number of partitions.	1
ColdDataSize	long	The total amount of cold data. Unit: byte. NoteThe 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

HTTP status code	Error code	Error message	Description
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.
503	ServiceUnavailable	An error occurred while processing your request.	The system is unavailable. Please try again later.

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