用DescribeAvailableAdvices來顯示可用優(yōu)化建議。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
adb:DescribeAvailableAdvices | get |
|
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBClusterId | string | 是 | 集群 ID。 說明
您可以調(diào)用 DescribeDBClusters 接口查看數(shù)倉版集群的集群 ID。
| am-bp198m028ih55**** |
RegionId | string | 是 | 地域 ID。 說明
您可以調(diào)用 DescribeRegions 接口查看可用地域的地域 ID。
| cn-hangzhou |
AdviceDate | long | 是 | 建議的生成日期,格式為 yyyyMMdd(UTC 時間)。 說明
數(shù)據(jù)是每天凌晨分析后生成,因此要填 T-1 以上的時間才查詢得到數(shù)據(jù)。譬如當(dāng)前是 20240627,那么應(yīng)該傳 20240626 或者更早的時間。
| 20221124 |
Lang | string | 是 | 設(shè)置建議的顯示語言,取值說明:
| zh |
PageSize | long | 是 | 每頁記錄數(shù),取值:
| 30 |
PageNumber | long | 是 | 頁碼,取值為:大于 0 且不超過 Integer 數(shù)據(jù)類型的最大值,默認(rèn)值為 1。 | 1 |
AdviceType | string | 否 | 建議的類型,取值說明:
| Index |
Keyword | string | 否 | 查詢關(guān)鍵字,支持根據(jù)表名模糊搜索。 | you_table_name |
SchemaTableName | string | 否 | 數(shù)據(jù)庫名和表名的字符串拼接。 | tpch.lineitem |
Order | string | 否 | 將查詢結(jié)果按指定字段進(jìn)行排序。格式為 JSON 字符串,例如
說明
若不設(shè)置參數(shù),默認(rèn)按照”預(yù)期優(yōu)化收益“降序排列。
| [{"Field":"Benefit","Type":"Desc"}] |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"Items": [
{
"AdviceId": "dcd04135-0925-4aed-a5a7-e7d92cb1****",
"AdviceDate": "20221124",
"AdviceType": "Index",
"SQL": "alter table `schema1`.`table1` drop key col1_1_idx",
"Reason": "15天未使用,歷史使用統(tǒng)計概率小于1%",
"Benefit": "節(jié)省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參數(shù) |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-04-17 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
2023-04-06 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |