用DescribeAvailableAdvices来显示可用优化建议。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
adb:DescribeAvailableAdvices | get | *DBCluster acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId} |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBClusterId | string | 是 | 集群 ID。 说明
您可以调用 DescribeDBClusters 接口查看数仓版集群的集群 ID。
| am-bp198m028ih55**** |
RegionId | string | 是 | 地域 ID。 说明
您可以调用 DescribeRegions 接口查看可用地域的地域 ID。
| cn-hangzhou |
AdviceDate | long | 是 | 建议的生成日期,格式为 yyyyMMdd(UTC 时间)。 说明
数据是每天凌晨分析后生成,因此要填 T-1 以上的时间才查询得到数据。譬如当前是 20240627,那么应该传 20240626 或者更早的时间。
| 20221124 |
Lang | string | 是 | 设置建议的显示语言,取值说明:
| zh |
PageSize | long | 是 | 每页记录数,取值:
| 30 |
PageNumber | long | 是 | 页码,取值为:大于 0 且不超过 Integer 数据类型的最大值,默认值为 1。 | 1 |
AdviceType | string | 否 | 建议的类型,取值说明:
| Index |
Keyword | string | 否 | 查询关键字,支持根据表名模糊搜索。 | you_table_name |
SchemaTableName | string | 否 | 数据库名和表名的字符串拼接。 | tpch.lineitem |
Order | string | 否 | 将查询结果按指定字段进行排序。格式为 JSON 字符串,例如
说明
若不设置参数,默认按照”预期优化收益“降序排列。
| [{"Field":"Benefit","Type":"Desc"}] |
返回参数
示例
正常返回示例
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": "adb_demo",
"TableName": "test_table"
}
],
"PageNumber": 1,
"PageSize": 30,
"RequestId": "96A55627-28E9-5E47-B8F6-D786BE551349",
"TotalCount": 30,
"SchemaTableNames": [
"[\n \"tpch.lineitem\",\n \"tpch.partsupp\",\n \"tpch.orders\"\n]"
]
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | MissingParameter.PageSize | The PageSize parameter is required. | 缺少PageSize参数 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-04-17 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-04-06 | OpenAPI 错误码发生变更 | 查看变更详情 |