調用DescribeAppliedAdvices接口來顯示已采納的優化建議。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
adb:DescribeAppliedAdvices | get |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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 |
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": "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 返回結構發生變更 | 查看變更詳情 |