調用CreateKillInstanceSessionTask接口，創建結束會話的任務。
接口說明
-
本接口只適用于 RDS MySQL 和 PolarDB MySQL 版實例。
-
使用阿里云或 DAS 的 SDK 時，建議使用最新版本。
-
在使用 SDK 調用 DAS 服務時，需要將地域指定為 cn-shanghai。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| hdm:CreateKillInstanceSessionTask | create | *全部資源 * |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| InstanceId | string | 是 | 實例 ID。 | rm-2ze8g2am97624**** |
| NodeId | string | 否 | 節點 ID。 說明
對于 PolarDB MySQL 版實例，需要提供節點 ID。如果沒有提供節點 ID，并且請求參數 KillAllSessions 配置為 true（即結束全部會話），將會遍歷 PolarDB MySQL 版實例所有節點，并結束每個節點上正在進行的會話。
| pi-bp1v203xzzh0a**** |
| DbUser | string | 是 | 具有結束會話權限的數據庫賬號。 | testUser |
| DbUserPassword | string | 是 | 數據庫賬號密碼。 | testPassword |
| IgnoredUsers | string | 否 | 忽略賬號列表，該列表中賬號的會話不會被結束。 說明
數據格式為 JSONArray 字符串，例如['數據庫賬號 1','數據庫賬號 2']，數據庫賬號間用英文逗號（,）分隔。
| ['db_user1','db_user2'] |
| KillAllSessions | boolean | 是 | 是否結束全部會話。
說明
該參數取值為 true 時，請求參數 IgnoredUsers 中賬號的會話、阿里云內部運維賬號的會話和Binlog Dump會話都不會被結束。
| true |
| SessionIds | string | 否 | 需要被結束的會話 ID 列表。 說明
數據格式為 JSONArray，例如[會話 ID1,會話 ID2]，會話 ID 間用英文逗號（,）分隔。如果請求參數 KillAllSessions 取值為 true（即結束全部會話），該列表會被忽略。
| [10805639,10805623,10805645,10805553,10805566,10805616] |
返回參數
示例
正常返回示例
JSON格式
{
"Code": 200,
"Message": "Successful",
"Data": "f77d535b45405bd462b21caa3ee8****",
"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. | 沒有權限執行該操作 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|
暫無變更歷史