调用GetKillInstanceSessionTaskResult获取结束会话任务的结果_数据库自治服务(DAS)-阿里云帮助中心

调用GetKillInstanceSessionTaskResult接口，获取结束会话任务的结果。

接口说明

本接口只适用于 RDS MySQL 和 PolarDB MySQL 版实例。
使用阿里云或 DAS 的 SDK 时，建议使用最新版本。
在使用 SDK 调用 DAS 服务时，需要将地域指定为 cn-shanghai。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。	rm-2ze1jdv45i7l6****
NodeId	string	否	节点 ID。说明对于 PolarDB MySQL 版实例，需要提供节点 ID。	pi-8vbkfj5a756um****
TaskId	string	是	任务 ID，调用 CreateKillInstanceSessionTask 接口时返回的任务 ID。	f77d535b45405bd462b21caa3ee8****

返回参数

名称	类型	描述	示例值
	object
Code	long	返回的状态码。	200
Data	object	返回的数据。
IgnoredUserSessionCount	long	指定的不会被结束的会话数量，包含忽略列表中账号的会话、阿里云内部运维账号的会话和Binlog Dump会话。	9
InstanceId	string	实例 ID。	rm-2ze1jdv45i7l6****
KillFailCount	long	结束失败的会话数量。	0
KillSuccessCount	long	结束成功的会话数量。	100
NodeId	string	节点 ID。说明 PolarDB MySQL 版实例的结束会话任务才会返回该数据。	pi-bp1h12rv501cv****
Result	array<object>	结束会话的详情列表。
result	object	结束会话的详情。
Active	boolean	是否是活跃会话。说明活跃会话判断逻辑：命令是 Query 或者 Execute，以及未结束事务中的会话。	true
Command	string	会话执行的命令类型。	Sleep
Db	string	数据库名。	dbTest
Host	string	发起该会话主机的 IP 地址和端口。	100.104.XX.XX:23428
Id	long	会话 ID。	8357518
Info	string	会话执行的 SQL 语句。	SELECT sleep(60)
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
State	string	会话状态。	Sending data
TaskId	string	结束该会话的子任务 ID。	task_d9e94107-6116-4ac3-b874-81466aff****
Time	long	执行时间，单位为秒（s）。	1
User	string	数据库账号。	testUser
Sessions	array	需要结束的会话 ID 列表。说明结束全部会话时，实例或节点上的所有会话 ID 列表。
sessions	long	会话 ID。	[ 152, 112, 106, 146, 8357323, 5697053, 8357518, 8357519, 14964383 ]
TaskId	string	任务 ID。	f77d535b45405bd462b21caa3ee8****
TaskState	string	结束会话任务的状态： RUNNING：正在运行。 SUCCESS：成功。 FAILURE：失败。 ERROR：其他错误。	SUCCESS
UserId	string	阿里云主账号 ID。	164882191396****
Message	string	请求返回消息。说明请求成功时该参数返回 Successful，请求失败时会返回请求异常信息（如错误码等）。	Successful
RequestId	string	请求 ID。	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	boolean	请求是否执行成功： true：执行成功。 false：执行失败。	true

示例

正常返回示例

JSON格式

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

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史