调用DescribeAppliedAdvices显示已采纳的优化_云原生数据仓库AnalyticDB(AnalyticDB)-阿里云帮助中心

调用DescribeAppliedAdvices接口来显示已采纳的优化建议。

调试

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

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
adb:DescribeAppliedAdvices	get	DBCluster acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}	无	无

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	是	AnalyticDB MySQL 数仓版集群 ID。说明您可以调用 DescribeDBClusters 接口查看数仓版集群的集群 ID。	am-uf6g8w25jacm7****
RegionId	string	是	地域 ID。说明您可通过接口 DescribeRegions 查看可用的地域 ID。	cn-hangzhou
StartTime	long	否	查询建议的开始日期，格式为 yyyyMMdd（UTC 时间）。	20220811
EndTime	long	否	查询建议的结束日期，格式为 yyyyMMdd（UTC 时间）。	20220824
Lang	string	否	设置建议的显示语言，取值说明： zh：简体中文（默认语言）。 en：英文。 ja：日文。 zh-tw：繁体中文。	zh
PageSize	long	否	每页记录数，取值： 30（默认值） 50 100	30
PageNumber	long	否	页码，取值为：大于 0 且不超过 Integer 数据类型的最大值，默认值为 1。	1
AdviceType	string	否	建议的类型，取值说明： INDEX：索引优化。 TIERING：冷热数据优化。	INDEX
Keyword	string	否	查询关键字，支持根据表名模糊搜索。	you_table_name
SchemaTableName	string	否	数据库名和表名。格式为数据库.表。	tpch.lineitem
Order	string	否	将查询结果按指定字段进行排序。格式为 JSON 字符串，例如`[{"Field":"SchemaName","Type":"Asc"}]`。其中： `Field`表示排序字段。支持如下取值： `SchemaName`：数据库名。 `TableName`：表名。 `JobStatus`：表 Build 任务状态。 `SubmitTime`：建议下发的时间。 `Benefit`：预期优化收益。 `Type`表示排序方式。支持如下取值： `Asc`：升序排序。 `Desc`：降序排序。说明若不设置参数，默认按照优化建议下发的时间降序排列。	[{"Field":"Benefit","Type":"Desc"}]

返回参数

名称	类型	描述	示例值
	object	返回对象。
Items	array<object>	详情。
Items	object	建议列表。
AdviceId	string	建议 ID。	7417db9c-914d-43f3-a123-4d0e448f****
SubmitTime	string	建议下发的时间，格式：yyMMddHHmm（UTC 时间）。	2208131600
SubmitStatus	string	建议的下发状态。取值说明： SUCCEED：成功。 FAILED：失败。	SUCCEED
SQL	string	应用建议的 SQL 语句。	alter table `schema1`.`table1` drop key col1_1_idx
RollbackSQL	string	回滚建议的 SQL 语句。	alter table `schema1`.`table1` add key col1_1_idx(col1)
JobStatus	string	执行建议的任务的状态。取值说明： SUCCEED：成功。 FAILED：失败。	SUCCEED
Benefit	string	建议的收益。	节省0.4 GB的存储空间
BuildSQL	string	执行 Build 任务的 SQL 语句。	build table `schema1`.`table1`
TotalCount	long	返回的建议总数，取值为：大于等于 0 且不超过 Integer 数据类型的最大值，默认值为 0。	1
PageSize	long	每页记录数，取值： 30（默认值） 50 100	30
PageNumber	long	页码，取值为：大于 0 且不超过 Integer 数据类型的最大值，默认值为 1。	1
SchemaName	string	数据库名。	adb_demo
TableName	string	表名。	test
PageNumber	long	页码，取值为：大于 0 且不超过 Integer 数据类型的最大值，默认值为 1。	1
PageSize	long	每页记录数，取值： 30（默认值） 50 100	30
RequestId	string	请求 ID。	84489769-3065-5A28-A4CB-977CD426F1C3
TotalCount	long	返回的结果总数，取值为：大于等于 0 且不超过 Integer 数据类型的最大值，默认值为 0。	1
SchemaTableNames	array	数据库名和表名的字符串拼接列表。
SchemaTableNames	string	数据库名和表名的字符串拼接。	[ "tpch.lineitem", "tpch.partsupp", "tpch.orders" ]

示例

正常返回示例

JSON格式

{
  "Items": [
    {
      "AdviceId": "7417db9c-914d-43f3-a123-4d0e448f****",
      "SubmitTime": "2208131600",
      "SubmitStatus": "SUCCEED",
      "SQL": "alter table `schema1`.`table1` drop key col1_1_idx",
      "RollbackSQL": "alter table `schema1`.`table1` add key col1_1_idx(col1)",
      "JobStatus": "SUCCEED",
      "Benefit": "节省0.4 GB的存储空间",
      "BuildSQL": "build table `schema1`.`table1`",
      "TotalCount": 1,
      "PageSize": 30,
      "PageNumber": 1,
      "SchemaName": "adb_demo",
      "TableName": "test"
    }
  ],
  "PageNumber": 1,
  "PageSize": 30,
  "RequestId": "84489769-3065-5A28-A4CB-977CD426F1C3",
  "TotalCount": 1,
  "SchemaTableNames": [
    "[\n  \"tpch.lineitem\",\n  \"tpch.partsupp\",\n  \"tpch.orders\"\n]"
  ]
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-04-17	OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情