全部產品
Search

搜尋本產品

    Database Autonomy Service：CreateKillInstanceSessionTask - 建立結束會話的任務

    文件中心

    Database Autonomy Service：CreateKillInstanceSessionTask - 建立結束會話的任務

    更新時間：Dec 19, 2025

    調用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：是。

    • false：否。

    說明

    該參數取值為 true 時，請求參數 IgnoredUsers 中帳號的會話、阿里雲內部營運帳號的會話和Binlog Dump會話都不會被結束。

    true
    SessionIds

    string

    否

    需要被結束的會話 ID 列表。

    說明

    資料格式為 JSONArray，例如[會話 ID1,會話 ID2]，會話 ID 間用英文逗號（,）分隔。如果請求參數 KillAllSessions 取值為 true（即結束全部會話），該列表會被忽略。

    [10805639,10805623,10805645,10805553,10805566,10805616]

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Code

    integer

    返回的狀態代碼。

    200
    Message

    string

    請求返回訊息。

    說明

    請求成功時該參數返回 Successful，請求失敗時會返回請求異常資訊（如錯誤碼等）。

    Successful
    Data

    string

    結束會話的任務 ID。

    說明

    PolarDB MySQL 版執行個體調用該 API 介面，請求參數 NodeId 為空白（即未指定節點 ID），並且請求參數 KillAllSessions 配置為 true（即結束全部會話）時，會按照節點數量返回任務 ID 列表，例如["f77d535b45405bd462b21caa3ee8****", "e93ab549abb081eb5dcd5396a29b****"]

    f77d535b45405bd462b21caa3ee8****
    RequestId

    string

    請求 ID。

    B6D17591-B48B-4D31-9CD6-9B9796B2****
    Success

    boolean

    請求是否執行成功：

    • true：執行成功。

    • false：執行失敗。

    true

    樣本

    正常返回樣本

    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.

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。