調用GetRunningSqlConcurrencyControlRules介面,擷取正在執行的限流規則。
介面說明
本介面適用的資料庫引擎為:
RDS MySQL
PolarDB MySQL 版
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
hdm:GetRunningSqlConcurrencyControlRules |
get |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| ConsoleContext |
string |
否 |
備用參數。 |
None |
| InstanceId |
string |
是 |
執行個體 ID。 說明
僅支援 RDS MySQL 和 PolarDB MySQL 版執行個體。 |
rm-2ze1jdv45i7l6**** |
| PageNo |
integer |
否 |
頁碼,取值大於 0 且不超過 整數資料類型的最大值,預設值為 1。 |
1 |
| PageSize |
integer |
否 |
每頁最大記錄數,取值大於 0 且不超過 整數資料類型的最大值,預設值為 10。 |
10 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| Code |
string |
返回的狀態代碼。 |
200 |
| Message |
string |
請求返回訊息。 說明
請求成功時該參數返回 Successful,請求失敗時會返回請求異常資訊(如錯誤碼等)。 |
Successful |
| Data |
object |
詳細資料列表,包括資訊總數、錯誤碼等。 |
|
| Total |
integer |
總記錄數。 |
2 |
| List |
object |
||
| runningRules |
array<object> |
返回資訊列表。 |
|
|
object |
|||
| ItemId |
integer |
當前執行個體的限流規則 ID。 |
16 |
| SqlType |
string |
選擇 SQL 的類型。取值:
|
SELECT |
| InstanceId |
string |
執行個體 ID。 |
rm-2ze1jdv45i7l6**** |
| SqlKeywords |
string |
需要限流的 SQL 關鍵詞。 說明
多個關鍵詞間用波浪線(~)分隔,SQL 陳述式中需要同時包含這些關鍵詞才會觸發限流規則。 |
call~open~api~test~4~from~POP |
| StartTime |
integer |
擷取正在執行的限流規則的開始時間,格式為 Unix 時間戳記,單位為毫秒。 |
1608888296000 |
| KeywordsHash |
string |
雜湊值,根據輸入的限流關鍵詞計算出來的值。 |
b0b8aceeb43baea87b219c81767b**** |
| ConcurrencyControlTime |
integer |
SQL 限流的生效時間長度,單位為秒。 說明
限流規則僅在生效時間內開啟。 |
600 |
| UserId |
string |
阿里雲帳號 ID。 |
testxxx |
| MaxConcurrency |
string |
SQL 最大並發數,取值為大於或等於 1 的整數。 說明
當包含關鍵詞的 SQL 達到最大並發數時會觸發限流策略。 |
2 |
| Status |
string |
限流規則的生效狀態,取值為 Open:限流規則正在生效中。 |
Open |
| RequestId |
string |
請求 ID。 |
B6D17591-B48B-4D31-9CD6-9B9796B2**** |
| Success |
string |
請求是否執行成功:
|
true |
樣本
正常返回樣本
JSON格式
{
"Code": "200",
"Message": "Successful",
"Data": {
"Total": 2,
"List": {
"runningRules": [
{
"ItemId": 16,
"SqlType": "SELECT",
"InstanceId": "rm-2ze1jdv45i7l6****",
"SqlKeywords": "call~open~api~test~4~from~POP",
"StartTime": 1608888296000,
"KeywordsHash": "b0b8aceeb43baea87b219c81767b****",
"ConcurrencyControlTime": 600,
"UserId": "testxxx",
"MaxConcurrency": "2",
"Status": "Open"
}
]
}
},
"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. | 沒有許可權執行該操作 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。