Detect Tables with Excessive Primary Keys Using DescribeExcessivePrimaryKeys - AnalyticDB for MySQL - Alibaba Cloud - AnalyticDB

Queries tables with excessive primary key fields in an AnalyticDB for MySQL Data Warehouse Edition (V3.0) 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:DescribeExcessivePrimaryKeys

get

*DBClusterLakeVersion

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

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID. Note You can call the DescribeDBClusters operation to query the IDs of all AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters in a region.	am-bp1u8c0mgfg58****
RegionId	string	Yes	The region ID of the cluster. Note You can call the DescribeRegions operation to query the most recent region list.	cn-beijing
StartTime	string	No	The start of the time range to query, in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2021-09-30T00:10Z
EndTime	string	No	The end of the time range to query, in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2023-05-15T07:15Z
PageSize	integer	No	The number of entries per page. Valid values: 30 (default) 50 100	20
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
Lang	string	No	The display language of the suggestions. Valid values: zh (default): 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":"TableSchema","Type":"Asc"}]`. `Field` specifies the field by which to sort the query results. Valid values: `TableSchema`: the name of the database to which the table belongs. `TableName`: the name of the table. `AccessCount`: the number of accesses to the table. `Type` specifies the sorting order. Valid values: `Asc`: ascending order. `Desc`: descending order. Note If not specified, results are sorted in ascending order by database and table.	[{"Field":"TableName","Type":"Desc"}]

Response elements

Element	Type	Description	Example
	object
TotalCount	string	The total number of entries returned.	1
PageNumber	integer	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	The number of entries per page. Valid values: 30 (default) 50 100	10
RequestId	string	The request ID.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
DBClusterId	string	The cluster ID. Note You can call the DescribeDBClusters operation to query the IDs of all AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters in a region.	am-bp11q28kvl688****
Tables	array<object>	The tables with excessive primary keys.
	object
TableName	string	The name of the table.	test
SchemaName	string	The name of the database.	adb_demo
ColumnCount	integer	The total number of columns.	26
PrimaryKeyCount	integer	The number of primary key fields.	1
PrimaryKeyColumns	string	The primary key fields.	id,date
SpaceRatio	number	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%.	20
TotalSize	integer	The cold data size. Unit: bytes. Note Formula: Cold data size = Data size of table records + Data size of regular indexes + Data size of primary key indexes + Size of other data.	1073741824
PrimaryKeyIndexSize	integer	The data size of primary key indexes. Unit: bytes.	2345
DetectionItems	array<object>	The detection items and results.
	object
Name	string	The name of the detection item.	evm_identity
Message	string	The detection result.	OK
Status	string	The severity level of the detection result.	NORMAL WARNING CRITICAL
AccessDeniedDetail	string	The access denial details. Note Returned only if Resource Access Management (RAM) permission verification failed.	{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "1906102576997697", "EncodedDiagnosticMessage": "AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcNqPqHV6lwR4INiAGjIvK1ngXxN1O+6ORRB6A8YvztEOGywOk81ZmuNk0YrNy+qk7+UVDTHeXKsy8h9e/ePY/LMidj0RCmDpo/YpCumd0UGe0qEPe2U+UJAm/+UHlnEFLVg6BP3yIB5D++MCy7mgWm8Kwyhk62IeYly4hQ+5IpXjkh1GQXuDgLVVPVpxEek9n30vnCUL4KsaMgfa7dgojb+3TM8xGsD2zVK5STJNrsXclscIJEqyNXd7CBYiRJVZi1HPO6drN9WW0chLpCSTgjO8n0bNanZaxXKumW9PSwV58UoSFASeMWfZK3TLngX+oq8nGmnTwcJosVjfF4RGzAnS1IXt0Q9N2WHDnpwyLBU/nOz7Hsy8IZ+h+OVjsBTXSM9688/vOF707a5mNzpETvQeGRcua3A5livcKAM2cML0yeUs/Zyj/+BGqtVa+wektspDHC/CECh6R5lxQjRmUdPawY8VDs2onmdLuEH8DdmYt+Yv/jBFBUMWOyAluzkPYcX5nuQKouCIUJUFTSbsJsuH5CTIh7Ls5rbmkj+T1qTVz8gnDR8LxwaqoMSna+elXgVyOOxXtMkenVntsmoC3p/4G7yTPL1hu8JyWGIIvZHZGGLXGEH7FeSuMV8buKxPGFWG3arG8e9LGvDdz5dgTien4y6G5AQ0o1iQdXDos5VWdH3u7k5PrsvdEOpvMi6uSd8a42na80FsYlgGlwM5upydcWUC5Un2HCkJpT1xgk2L6shdVTrK6bidRrqE784FhW9bBQePzGaxSupPENZya0VUctRt+7uq3QwIn4y5jzjgX0E0jgmqPrgiVDjBesMQZYfGPCGysWYWYzfoh+G6V7N2VVGtNnGUwNWzM0WJBPONAgxPv+AmixFRCQ==", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "202515810214480629", "NoPermissionType": "ImplicitDeny", "AuthAction": "adb:DescribeExcessivePrimaryKeys" }

Examples

Success response

JSON format

{
  "TotalCount": "1",
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "DBClusterId": "am-bp11q28kvl688****",
  "Tables": [
    {
      "TableName": "test",
      "SchemaName": "adb_demo",
      "ColumnCount": 26,
      "PrimaryKeyCount": 1,
      "PrimaryKeyColumns": "id,date",
      "SpaceRatio": 20,
      "TotalSize": 1073741824,
      "PrimaryKeyIndexSize": 2345
    }
  ],
  "DetectionItems": [
    {
      "Name": "evm_identity",
      "Message": "OK",
      "Status": "NORMAL\nWARNING\nCRITICAL"
    }
  ],
  "AccessDeniedDetail": "{\n    \"PolicyType\": \"AccountLevelIdentityBasedPolicy\",\n    \"AuthPrincipalOwnerId\": \"1906102576997697\",\n    \"EncodedDiagnosticMessage\": \"AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcNqPqHV6lwR4INiAGjIvK1ngXxN1O+6ORRB6A8YvztEOGywOk81ZmuNk0YrNy+qk7+UVDTHeXKsy8h9e/ePY/LMidj0RCmDpo/YpCumd0UGe0qEPe2U+UJAm/+UHlnEFLVg6BP3yIB5D++MCy7mgWm8Kwyhk62IeYly4hQ+5IpXjkh1GQXuDgLVVPVpxEek9n30vnCUL4KsaMgfa7dgojb+3TM8xGsD2zVK5STJNrsXclscIJEqyNXd7CBYiRJVZi1HPO6drN9WW0chLpCSTgjO8n0bNanZaxXKumW9PSwV58UoSFASeMWfZK3TLngX+oq8nGmnTwcJosVjfF4RGzAnS1IXt0Q9N2WHDnpwyLBU/nOz7Hsy8IZ+h+OVjsBTXSM9688/vOF707a5mNzpETvQeGRcua3A5livcKAM2cML0yeUs/Zyj/+BGqtVa+wektspDHC/CECh6R5lxQjRmUdPawY8VDs2onmdLuEH8DdmYt+Yv/jBFBUMWOyAluzkPYcX5nuQKouCIUJUFTSbsJsuH5CTIh7Ls5rbmkj+T1qTVz8gnDR8LxwaqoMSna+elXgVyOOxXtMkenVntsmoC3p/4G7yTPL1hu8JyWGIIvZHZGGLXGEH7FeSuMV8buKxPGFWG3arG8e9LGvDdz5dgTien4y6G5AQ0o1iQdXDos5VWdH3u7k5PrsvdEOpvMi6uSd8a42na80FsYlgGlwM5upydcWUC5Un2HCkJpT1xgk2L6shdVTrK6bidRrqE784FhW9bBQePzGaxSupPENZya0VUctRt+7uq3QwIn4y5jzjgX0E0jgmqPrgiVDjBesMQZYfGPCGysWYWYzfoh+G6V7N2VVGtNnGUwNWzM0WJBPONAgxPv+AmixFRCQ==\",\n    \"AuthPrincipalType\": \"SubUser\",\n    \"AuthPrincipalDisplayName\": \"202515810214480629\",\n    \"NoPermissionType\": \"ImplicitDeny\",\n    \"AuthAction\": \"adb:DescribeExcessivePrimaryKeys\"\n  }"
}

Error codes

HTTP status code	Error code	Error message	Description
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.