DescribeExcessivePrimaryKeys - 检测主键过多表

更新时间: 2024-12-18 13:44:25

查看集群存在主键过多的表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
adb:DescribeExcessivePrimaryKeysget
*DBClusterLakeVersion
acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

请求参数

名称类型必填描述示例值
DBClusterIdstring

集群 ID。

说明 您可以通过 DescribeDBClusters 接口查看账号下数仓版集群的集群 ID。
am-bp1u8c0mgfg58****
RegionIdstring

地域 ID。

说明 您可以调用 DescribeRegions 接口查看指定数仓版集群的地域 ID。
cn-beijing
StartTimestring

查询开始时间。格式为yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2021-09-30T00:10Z
EndTimestring

查询结束时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2023-05-15T07:15Z
PageSizeinteger

每页记录数,取值范围如下:

  • 30(默认值)。
  • 50
  • 100
20
PageNumberinteger

页码,取值为大于 0 且不超过 Integer 数据类型最大值的正整数。默认值为 1

1
Langstring

设置建议的显示语言,取值说明:

  • zh(默认值):简体中文。
  • en:英文。
  • ja:日文。
  • zh-tw:繁体中文。
zh
Orderstring

将查询结果按指定字段进行排序。格式为 JSON 字符串,例如[{"Field":"TableSchema","Type":"Asc"}]。其中:

  • Field表示排序字段。支持如下取值:
    • TableSchema:表所属的数据库名。
    • TableName:表名。
    • AccessCount:表被访问的次数。
  • Type表示排序方式。支持如下取值:
    • Asc:升序排序。
    • Desc: 降序排序。
说明 若不设置参数,默认按照目标表所属的数据库升序排列。
[{"Field":"TableName","Type":"Desc"}]

返回参数

名称类型描述示例值
object
TotalCountstring

返回的结果总数,取值为:大于等于 0 且不超过 Integer 数据类型的最大值,默认值为 0。

1
PageNumberinteger

页码,取值为:大于 0 且不超过 Integer 数据类型的最大值,默认值为 1。

1
PageSizeinteger

每页记录数,取值:

  • 30(默认值)
  • 50
  • 100
10
RequestIdstring

请求 ID。

1AD222E9-E606-4A42-BF6D-8A4442913CEF
DBClusterIdstring

集群 ID。

说明 您可以调用 DescribeDBClusters 接口查看数仓版集群的集群 ID。
am-bp11q28kvl688****
Tablesarray<object>

表列表。

ExcessivePrimaryKeyInfosobject

检测结果列表

TableNamestring

表名。

test
SchemaNamestring

数据库名。

adb_demo
ColumnCountinteger

总列数。

26
PrimaryKeyCountinteger

主键字段个数。

1
PrimaryKeyColumnsstring

主键字段列表。

id,date
SpaceRatiodouble

表空间占比,单位:%。

说明 计算公式为:表空间占比 = (表总数据量 / 实例总数据量) * 100。
20
TotalSizelong

冷数据总量,单位:Byte。

说明 计算公式为:冷数据总量 = 表记录数据量 + 普通索引数据量 + 主键索引数据量 + 其他。
1073741824
PrimaryKeyIndexSizelong

主键索引数据量,单位:Byte。

2345
DetectionItemsarray<object>

检测项及检测结果列表。

DetectionItemsArrayobject

检测项及检测结果列表。

Namestring

检测项名。

主键字段过多
Messagestring

检测结果。

检测到表存在主键过多的情况
Statusstring

检测结果状态程度。

NORMAL WARNING CRITICAL
AccessDeniedDetailstring

访问被拒绝详细信息。

{ "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" }

示例

正常返回示例

JSON格式

{
  "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": "主键字段过多",
      "Message": "检测到表存在主键过多的情况",
      "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  }"
}

错误码

HTTP status code错误码错误信息描述
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.您指定的 DBClusterId 不存在,请确认 DBClusterId 值是否正确。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
上一篇: DescribeTableStatistics - 查询表统计信息 下一篇: 实例运行报告