調用UpdateAutoThrottleRulesAsync接口,采用異步方式,批量設置指定數據庫實例的自動SQL限流配置參數。
接口說明
說明
異步調用后不會立即返回完整結果,首先需要調用該接口獲取 ResultId,然后使用返回數據的 ResultId,重新發起調用,直到 isFinish 取值為 true 時,返回完整結果。即獲取一次完整數據,至少需要調用該接口兩次。
使用該接口需滿足以下前提條件:
-
在使用 SDK 調用 DAS 服務時,需要將地域指定為 cn-shanghai。
-
目標數據庫實例已開啟自治服務,詳情請參見自治中心。
-
目標數據庫實例為:
- RDS MySQL 5.6、5.7、 8.0 高可用系列、三節點企業系列。
- PolarDB MySQL 版 5.6 集群版、5.7 集群版、 8.0 集群版。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
hdm:UpdateAutoThrottleRulesAsync | none | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ConsoleContext | string | 否 | 備用參數。 | None |
InstanceIds | string | 是 | 數據庫實例 ID。 說明
數據格式為 JSONArray,例如 ['實例 ID1','實例 ID2'] ,實例 ID 間用英文逗號(,)分隔。
| ['rm-2ze8g2am97624****','rm-2ze9xrhze0709****'] |
CpuUsage | double | 是 | CPU 利用率閾值,取值范圍:70%~100%。 | 70 |
CpuSessionRelation | string | 是 | CPU 利用率閾值和活躍會話數閾值的邏輯關系。
| OR |
ActiveSessions | long | 是 | 活躍會話數閾值。
| 16 |
AbnormalDuration | double | 是 | 觸發自動 SQL 限流的異常的持續時間閾值,取值范圍:大于等于 2 的正整數,單位:分鐘。 | 2 |
MaxThrottleTime | double | 是 | 最大限流時長,取值為正整數,單位:分鐘。 | 10 |
AllowThrottleStartTime | string | 是 | 可限流時間段的開始時間(UTC 時間)。 | 00:00Z |
AllowThrottleEndTime | string | 是 | 可限流時間段的結束時間(UTC 時間)。 | 23:59Z |
AutoKillSession | boolean | 是 | 是否同時 KILL 執行中的異常 SQL: 說明
異常 SQL:與需要限流的 SQL 模板相同。
| true |
ResultId | string | 否 | 異步請求的 ID。 說明
異步調用后不會立即返回完整結果,首先需要調用該接口獲取 ResultId,然后使用返回數據的 ResultId,重新發起調用,直到 isFinish 取值為 true 時,返回完整結果。即獲取一次完整數據,至少需要調用該接口兩次。
| async__507044db6c4eadfa2dab9b084e80**** |
返回參數
示例
正常返回示例
JSON
格式
{
"Code": 200,
"Message": "Successful",
"Data": {
"Fail": false,
"ConfigResponse": {
"TotalInstanceCount": 2,
"ConfigSuccessInstanceCount": 1,
"ConfigFailInstanceCount": 1,
"ConfigSuccessInstanceList": [
{
"ConfigSuccess": true,
"InstanceId": "rm-2ze8g2am97624****"
}
],
"ConfigFailInstanceList": [
{
"ConfigSuccess": false,
"InstanceId": "rm-2ze9xrhze0709****",
"ErrorMessage": "instance das autonomy service is off or can not find instance"
}
]
},
"ResultId": "async__665ee69612f1627c7fd9f3c85075****",
"IsFinish": true,
"State": "SUCCESS",
"Complete": true,
"Timestamp": 1645668213000
},
"RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
"Success": true
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | InvalidParams | The request parameters are invalid. | 請求參數錯誤 |
403 | NoPermission | You are not authorized to do this action. | 沒有權限執行該操作 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2023-11-17 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |