Non-Partitioned Table Size API Overview - AnalyticDB for MySQL - Alibaba Cloud - AnalyticDB

Queries oversized non-partitioned tables in an AnalyticDB for MySQL 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:DescribeOversizeNonPartitionTableInfos

get

*DBClusterLakeVersion

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

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID.	am-8vb46cpn2aaxxxxxx
RegionId	string	Yes	The region ID.	cn-hangzhou
StartTime	string	No	The start of the time range to query. Specify the time in ISO 8601 format: yyyy-MM-ddTHH:mm:ssZ. The time must be in UTC.	2022-09-06T03:06:00Z
EndTime	string	No	The end of the time range to query. Specify the time in ISO 8601 format: yyyy-MM-ddTHH:mm:ssZ. The time must be in UTC.	2021-05-03T15:01:00Z
PageSize	integer	No	The number of entries per page.	30
PageNumber	integer	No	The page number. Pages start from page 1.	1
Lang	string	No	The language of file titles and error messages. Valid values: zh: simplified Chinese. en: English. ja: Japanese. zh-tw: traditional Chinese.	zh
Order	string	No	The sort order for query results. Specify the value in JSON format. Example: `[{"Field":"SchemaName","Type":"Desc"}]`. `Field` specifies the field to sort by. Valid values: `SchemaName`: the name of the database to which the table belongs. `TableName`: the name of the table. `IndexSize`: the data size of regular indexes. `PrimaryKeySize`: the data size of the primary key index. `DataSize`: the data size of table records. `LocalDataSize`: the size of hot data. `RemoteDataSize`: the size of cold data. `SpaceRatio`: the storage percentage of the table. `Type` specifies the sorting order. Valid values: `Asc`: ascending order. `Desc`: descending order. Note If this parameter is not specified, results are sorted by total data size per table in descending order.	[{\"Field\":\"SchemaName\",\"Type\":\"Asc\"}]

Response elements

Element	Type	Description	Example
	object	The response parameters.
TotalCount	string	The total number of entries returned.	21
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	100
RequestId	string	The request ID.	F67B5AC5-6CDE-5187-9E25-B1EEE9AC4D91
DBClusterId	string	The cluster ID.	am-8vb46cpn2aaxxxxxx
Tables	array<object>	The queried oversized non-partitioned tables.
	object	The queried oversized non-partitioned table.
SchemaName	string	The name of the database.	adb_demo
TableName	string	The name of the table.	test
RowCount	integer	The number of rows in the table.	3294
IndexSize	integer	The data size of regular indexes. Unit: bytes.	1073741824
DataSize	integer	The data size of table records. Unit: bytes. Note Table record data size excludes regular and primary key indexes.	21474836480
LocalDataSize	integer	The size of hot data. Unit: bytes.	24696061952
PrimaryKeySize	integer	The data size of the primary key index. Unit: bytes.	2147483648
RemoteDataSize	integer	The size of cold data. Unit: bytes.	0
SpaceRatio	number	The storage percentage of the table. Unit: %. Note Formula: Table storage percentage = Total table data size / Total cluster data size × 100%.	23
DetectionItems	array<object>	Detection items and results.
	object	A detection item and its result.
Name	string	The name of the detection item.	Oversized non-partitioned tables
Message	string	Details about the detection result.	Multiple oversized non-partitioned tables are detected.
Status	string	The severity level of the detection result. Valid values: NORMAL WARNING CRITICAL	WARNING

Examples

Success response

JSON format

{
  "TotalCount": "21",
  "PageNumber": 1,
  "PageSize": 100,
  "RequestId": "F67B5AC5-6CDE-5187-9E25-B1EEE9AC4D91",
  "DBClusterId": "am-8vb46cpn2aaxxxxxx",
  "Tables": [
    {
      "SchemaName": "adb_demo",
      "TableName": "test",
      "RowCount": 3294,
      "IndexSize": 1073741824,
      "DataSize": 21474836480,
      "LocalDataSize": 24696061952,
      "PrimaryKeySize": 2147483648,
      "RemoteDataSize": 0,
      "SpaceRatio": 23
    }
  ],
  "DetectionItems": [
    {
      "Name": "Oversized non-partitioned tables",
      "Message": "Multiple oversized non-partitioned tables are detected.",
      "Status": "WARNING"
    }
  ]
}

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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.