調用GetMySQLAllSessionAsync接口,采用異步方式獲取實例當前會話數據,并按照不同維度統計會話信息。
接口說明
說明
異步調用方式不會立即返回完整結果,首先需要調用該接口獲取 ResultId,然后使用返回數據的 ResultId,重新發起調用,直到 isFinish 取值為 true 時,返回完整結果。即獲取一次完整數據,至少需要調用該接口兩次。
-
本接口只適用于 RDS MySQL,PolarDB MySQL 版和 PolarDB-X 2.0 實例。
-
使用阿里云或 DAS 的 SDK 時,建議使用最新版本。
-
在使用 SDK 調用 DAS 服務時,需要將地域指定為 cn-shanghai。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
hdm:GetMySQLAllSessionAsync | get | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 實例 ID。 說明
僅支持 RDS MySQL、PolarDB MySQL 版和 PolarDB-X 2.0 實例。
| rm-2ze8g2am97624**** |
NodeId | string | 否 | 節點 ID。 說明
對于 PolarDB MySQL 版實例,需要提供節點 ID。不指定節點 ID 時,默認返回主節點的會話數據。
| pi-wz954ryd8f893**** |
ResultId | string | 否 | 異步請求的 ID。 說明
異步調用方式不會立即返回完整結果,首先需要調用該接口獲取 ResultId,然后使用返回數據的 ResultId,重新發起調用,直到 isFinish 取值為 true 時,返回完整結果。即獲取一次完整數據,至少需要調用該接口兩次。
| async__507044db6c4eadfa2dab9b084e80**** |
返回參數
示例
正常返回示例
JSON
格式
{
"Code": 200,
"Message": "Successful",
"Data": {
"Fail": false,
"SessionData": {
"TotalSessionCount": 988,
"ActiveSessionCount": 10,
"MaxActiveTime": 6,
"SessionList": [
{
"SessionId": 14521783,
"User": "testUser",
"Client": "47.100.XX.XX",
"DbName": "dbTest",
"Command": "Query",
"Time": 6,
"State": "starting",
"SqlText": "INSERT INTO ...",
"UserClientAlias": "master-shanghai",
"TrxId": "754300775132",
"TrxDuration": 6,
"SqlTemplateId": "a7cac1a9"
}
],
"UserStats": [
{
"Key": "testUser",
"TotalCount": 2,
"ActiveCount": 1,
"ThreadIdList": [
0
],
"UserList": [
"['testUser']"
]
}
],
"ClientStats": [
{
"Key": "47.100.XX.XX",
"TotalCount": 2,
"ActiveCount": 1,
"ThreadIdList": [
0
],
"UserList": [
"['testUser']"
]
}
],
"DbStats": [
{
"Key": "dbTest",
"TotalCount": 2,
"ActiveCount": 1,
"ThreadIdList": [
0
],
"UserList": [
"['testUser']"
]
}
],
"TimeStamp": 1659581514000020
},
"ResultId": "async__507044db6c4eadfa2dab9b084e80****",
"IsFinish": true,
"State": "SUCCESS",
"Complete": true,
"Timestamp": 1660100753556
},
"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-08-25 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |