調(diào)用GetQueryOptimizeDataStats接口,獲取查詢治理模板數(shù)據(jù)。
接口說明
- 在使用阿里云 SDK 時,需要保證 aliyun-sdk-core 的版本大于 2.1.8,建議使用最新版本。
- 使用 DAS 的 SDK 的版本為 2.1.8 或以上。
- 在使用 SDK 調(diào)用 DAS 服務(wù)時,需要將地域指定為 cn-shanghai。
- 本接口適用的數(shù)據(jù)庫引擎為:
- RDS MySQL
- PolarDB MySQL 版
- RDS PostgreSQL
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點(diǎ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)操作 |
---|---|---|---|---|
hdm:GetQueryOptimizeDataStats | get | *全部資源 * |
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Engine | string | 是 | 數(shù)據(jù)庫引擎,取值:
| MySQL |
InstanceIds | string | 否 | 實(shí)例 ID,多個實(shí)例 ID 用逗號分隔。 | rm-2ze8g2am97624**** |
TagNames | string | 否 | 備用參數(shù)。 | None |
Keywords | string | 否 | SQL 文本關(guān)鍵詞,多個關(guān)鍵詞以空格分隔。 | select update |
LogicalOperator | string | 否 | 多個 SQL 文本關(guān)鍵詞的邏輯關(guān)系。
| or |
Rules | string | 否 | 需要過濾的規(guī)則,多個規(guī)則以逗號分隔。具體信息請參見查詢治理。 | DAS_NOT_IMPORTANT |
DbNames | string | 否 | 需要查詢的數(shù)據(jù)庫名。 | testdb01 |
Time | string | 是 | 查詢數(shù)據(jù)的日期,格式為 Unix 時間戳,單位為毫秒。 | 1642953600000 |
PageSize | string | 否 | 分頁查詢每頁最大記錄數(shù),默認(rèn)為 10。 | 10 |
PageNo | string | 否 | 分頁查詢的頁碼,從 1 開始,默認(rèn)為 1。 | 1 |
OrderBy | string | 否 | 排序字段,默認(rèn)為 count。
| count |
Asc | string | 否 | 是否升序排序,默認(rèn)為 true。
| true |
OnlyOptimizedSql | string | 否 | 是否只查詢待優(yōu)化的 SQL,默認(rèn)為 false。
| false |
SqlIds | string | 否 | SQL 模板 ID,您可調(diào)用 GetQueryOptimizeExecErrorStats 接口查詢 SQL 模板 ID。 | 2e8147b5ca2dfc640dfd5e43d96a**** |
Region | string | 否 | 實(shí)例所屬地域,取值:
此參數(shù)只有在請求參數(shù) InstanceIds 為空時有效。如果請求參數(shù) InstanceIds 為空時,按照 Region 參數(shù)設(shè)置的地域獲取數(shù)據(jù),系統(tǒng)默認(rèn)實(shí)例所屬地域?yàn)?strong data-sourcepos="7:98-7:110">cn-china;如果請求參數(shù) InstanceIds 不為空時,即使設(shè)置了 Region 參數(shù),也以 InstanceIds 所傳入的第一個實(shí)例所在地域?yàn)闇?zhǔn)獲取數(shù)據(jù)。 說明
在中國內(nèi)地各地域創(chuàng)建的實(shí)例,傳入此參數(shù)時,都為cn-china。
| cn-china |
User | string | 否 | 需要查詢的數(shù)據(jù)庫賬號。 | testUser |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"Code": "200",
"Message": "Successful",
"Data": {
"Total": 10,
"PageNo": 0,
"PageSize": 0,
"Extra": "None",
"List": [
{
"InstanceId": "rm-2ze8g2am97624****",
"Dbname": "testdb01",
"SqlId": "2e8147b5ca2dfc640dfd5e43d96a****",
"SqlType": "INSERT",
"Psql": "select 1",
"SqlSample": "select 2",
"Count": 100,
"MaxQueryTime": 1.1,
"AvgQueryTime": 1.1,
"MaxLockTime": 0.1,
"AvgLockTime": 0.1,
"MaxRowsExamined": 100000,
"AvgRowsExamined": 100.1,
"MaxRowsSent": 10000,
"AvgRowsSent": 100.1,
"MaxRowsAffected": 10000,
"AvgRowsAffected": 100.1,
"RuleList": [
{
"Name": "DAS_NOT_IMPORTANT",
"Type": "Predefined"
}
],
"User": "testUser"
}
]
},
"RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
"Success": "true"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | InvalidParams | The request parameters are invalid. | 請求參數(shù)錯誤 |
403 | NoPermission | You are not authorized to do this action. | 沒有權(quán)限執(zhí)行該操作 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2023-04-04 | OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
2023-03-29 | OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |