通過GetKillInstanceSessionTaskResult擷取結束會話任務的結果-資料庫自治服務-阿里雲 - Database Autonomy Service

調用GetKillInstanceSessionTaskResult介面，擷取結束會話任務的結果。

介面說明

本介面只適用於 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:GetKillInstanceSessionTaskResult

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	是	執行個體 ID。	rm-2ze1jdv45i7l6****
NodeId	string	否	節點 ID。說明對於 PolarDB MySQL 版執行個體，需要提供節點 ID。	pi-8vbkfj5a756um****
TaskId	string	是	任務 ID，調用 CreateKillInstanceSessionTask 介面時返回的任務 ID。	f77d535b45405bd462b21caa3ee8****

返回參數

名稱	類型	描述	樣本值
	object
Code	integer	返回的狀態代碼。	200
Message	string	請求返回訊息。說明請求成功時該參數返回 Successful，請求失敗時會返回請求異常資訊（如錯誤碼等）。	Successful
Data	object	返回的資料。
TaskId	string	任務 ID。	f77d535b45405bd462b21caa3ee8****
UserId	string	阿里雲主帳號 ID。	164882191396****
InstanceId	string	執行個體 ID。	rm-2ze1jdv45i7l6****
NodeId	string	節點 ID。說明 PolarDB MySQL 版執行個體的結束會話任務才會返回該資料。	pi-bp1h12rv501cv****
TaskState	string	結束會話任務的狀態： RUNNING：正在運行。 SUCCESS：成功。 FAILURE：失敗。 ERROR：其他錯誤。	SUCCESS
Sessions	array	需要結束的會話 ID 列表。說明結束全部會話時，執行個體或節點上的所有會話 ID 列表。
	integer	會話 ID。	[ 152, 112, 106, 146, 8357323, 5697053, 8357518, 8357519, 14964383 ]
KillSuccessCount	integer	結束成功的會話數量。	100
KillFailCount	integer	結束失敗的會話數量。	0
IgnoredUserSessionCount	integer	指定的不會被結束的會話數量，包含忽略列表中帳號的會話、阿里雲內部營運帳號的會話和Binlog Dump會話。	9
Result	array<object>	結束會話的詳情列表。
	object	結束會話的詳情。
Id	integer	會話 ID。	8357518
User	string	資料庫帳號。	testUser
Host	string	發起該會話主機的 IP 位址和連接埠。	100.104.XX.XX:23428
Db	string	資料庫名。	dbTest
Command	string	會話執行的命令類型。	Sleep
Time	integer	執行時間，單位為秒（s）。	1
State	string	工作階段狀態。	Sending data
Info	string	會話執行的 SQL 陳述式。	SELECT sleep(60)
Active	boolean	是否是活躍會話。說明活躍會話判斷邏輯：命令是 Query 或者 Execute，以及未結束事務中的會話。	true
TaskId	string	結束該會話的子任務 ID。	task_d9e94107-6116-4ac3-b874-81466aff****
Reason	string	結束該會話時的結果描述。 SESSION_KILLED：結束會話成功。 SESSION_EXPIRED：會話已到期。 SESSION_NO_PERMISSION：用於結束會話的帳號許可權不足。 SESSION_ACCOUNT_ERROR：用於結束會話的帳號或密碼錯誤。 SESSION_IGNORED_USER：不需要結束的帳號的會話。 SESSION_INTERNAL_USER_OR_COMMAND：阿里雲營運帳號的會話或者命令。 SESSION_KILL_TASK_TIMEOUT：結束會話逾時。 SESSION_OTHER_ERROR：其他錯誤。	SESSION_KILLED
RequestId	string	請求 ID。	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	boolean	請求是否執行成功： true：執行成功。 false：執行失敗。	true

樣本

正常返回樣本

JSON格式

{
  "Code": 200,
  "Message": "Successful",
  "Data": {
    "TaskId": "f77d535b45405bd462b21caa3ee8****",
    "UserId": "164882191396****",
    "InstanceId": "rm-2ze1jdv45i7l6****",
    "NodeId": "pi-bp1h12rv501cv****",
    "TaskState": "SUCCESS",
    "Sessions": [
      0
    ],
    "KillSuccessCount": 100,
    "KillFailCount": 0,
    "IgnoredUserSessionCount": 9,
    "Result": [
      {
        "Id": 8357518,
        "User": "testUser",
        "Host": "100.104.XX.XX:23428",
        "Db": "dbTest",
        "Command": "Sleep",
        "Time": 1,
        "State": "Sending data",
        "Info": "SELECT sleep(60)",
        "Active": true,
        "TaskId": "task_d9e94107-6116-4ac3-b874-81466aff****",
        "Reason": "SESSION_KILLED"
      }
    ]
  },
  "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.	沒有許可權執行該操作

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

變更歷史

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