文档

DescribeAvailableAdvices - 显示可用优化建议

更新时间:

用DescribeAvailableAdvices来显示可用优化建议。

调试

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

授权信息

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

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

请求参数

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

集群 ID。

说明 您可以调用 DescribeDBClusters 接口查看数仓版(3.0)集群的集群 ID。
am-bp198m028ih55****
RegionIdstring

地域 ID。

说明 您可以调用 DescribeRegions 接口查看可用地域的地域 ID。
cn-hangzhou
AdviceDatelong

建议的生成日期,格式为 yyyyMMdd(UTC 时间)。

20221124
Langstring

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

  • zh:简体中文(默认语言)。
  • en:英文。
  • ja:日文。
  • zh-tw:繁体中文。
zh
PageSizelong

每页记录数,取值:

  • 30(默认值)
  • 50
  • 100
30
PageNumberlong

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

1

返回参数

名称类型描述示例值
object

返回对象。

Itemsobject []

详情。

AdviceIdstring

建议 ID。

dcd04135-0925-4aed-a5a7-e7d92cb1****
AdviceDatestring

建议生成的时间,格式:yyyyMMdd(UTC 时间)。

20221124
AdviceTypestring

建议的类型,取值说明:

  • Index:索引优化。
  • Tiering:冷热数据优化。
Index
SQLstring

应用建议的 SQL 语句。

alter table `schema1`.`table1` drop key col1_1_idx
Reasonstring

生成优化建议的原因。

15天未使用,历史使用统计概率小于1%
Benefitstring

建议的收益。

节省0.4 GB的存储空间。
TotalCountlong

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

30
PageSizelong

每页记录数,取值:

  • 30(默认值)
  • 50
  • 100
30
PageNumberlong

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

1
PageNumberlong

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

1
PageSizelong

每页记录数,取值:

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

请求 ID。

96A55627-28E9-5E47-B8F6-D786BE551349
TotalCountlong

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

30

示例

正常返回示例

JSON格式

{
  "Items": [
    {
      "AdviceId": "dcd04135-0925-4aed-a5a7-e7d92cb1****",
      "AdviceDate": "20221124",
      "AdviceType": "Index",
      "SQL": "alter table `schema1`.`table1` drop key col1_1_idx",
      "Reason": "15天未使用,历史使用统计概率小于1%",
      "Benefit": "节省0.4 GB的存储空间。",
      "TotalCount": 30,
      "PageSize": 30,
      "PageNumber": 1,
      "SchemaName": "",
      "TableName": ""
    }
  ],
  "PageNumber": 1,
  "PageSize": 30,
  "RequestId": "96A55627-28E9-5E47-B8F6-D786BE551349",
  "TotalCount": 30,
  "SchemaTableNames": [
    ""
  ]
}

错误码

HTTP status code错误码错误信息描述
400MissingParameter.PageSizeThe PageSize parameter is required.缺少PageSize参数

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

变更历史

变更时间变更内容概要操作
2024-04-17OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:AdviceType
    新增入参:Keyword
    新增入参:SchemaTableName
    新增入参:Order
出参OpenAPI 返回结构发生变更
2023-04-06OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    新增错误码:400
  • 本页导读 (1)
文档反馈