GetKillInstanceSessionTaskResult - 获取结束会话任务的结果

调用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:GetKillInstanceSessionTaskResultget
*全部资源
*

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID。

rm-2ze1jdv45i7l6****
NodeIdstring

节点 ID。

说明 对于 PolarDB MySQL 版实例,需要提供节点 ID。
pi-8vbkfj5a756um****
TaskIdstring

任务 ID,调用 CreateKillInstanceSessionTask 接口时返回的任务 ID。

f77d535b45405bd462b21caa3ee8****

返回参数

名称类型描述示例值
object
Codelong

返回的状态码。

200
Messagestring

请求返回消息。

说明 请求成功时该参数返回 Successful,请求失败时会返回请求异常信息(如错误码等)。
Successful
Dataobject

返回的数据。

TaskIdstring

任务 ID。

f77d535b45405bd462b21caa3ee8****
UserIdstring

阿里云主账号 ID。

164882191396****
InstanceIdstring

实例 ID。

rm-2ze1jdv45i7l6****
NodeIdstring

节点 ID。

说明 PolarDB MySQL 版实例的结束会话任务才会返回该数据。
pi-bp1h12rv501cv****
TaskStatestring

结束会话任务的状态:

  • RUNNING:正在运行。
  • SUCCESS:成功。
  • FAILURE:失败。
  • ERROR:其他错误。
SUCCESS
Sessionsarray

需要结束的会话 ID 列表。

说明 结束全部会话时,实例或节点上的所有会话 ID 列表。
sessionslong

会话 ID。

[ 152, 112, 106, 146, 8357323, 5697053, 8357518, 8357519, 14964383 ]
KillSuccessCountlong

结束成功的会话数量。

100
KillFailCountlong

结束失败的会话数量。

0
IgnoredUserSessionCountlong

指定的不会被结束的会话数量,包含忽略列表中账号的会话、阿里云内部运维账号的会话和Binlog Dump会话。

9
Resultarray<object>

结束会话的详情列表。

resultobject

结束会话的详情。

Idlong

会话 ID。

8357518
Userstring

数据库账号。

testUser
Hoststring

发起该会话主机的 IP 地址和端口。

100.104.XX.XX:23428
Dbstring

数据库名。

dbTest
Commandstring

会话执行的命令类型。

Sleep
Timelong

执行时间,单位为秒(s)。

1
Statestring

会话状态。

Sending data
Infostring

会话执行的 SQL 语句。

SELECT sleep(60)
Activeboolean

是否是活跃会话。

说明 活跃会话判断逻辑: 命令是 Query 或者 Execute,以及未结束事务中的会话。
true
TaskIdstring

结束该会话的子任务 ID。

task_d9e94107-6116-4ac3-b874-81466aff****
Reasonstring

结束该会话时的结果描述。

  • 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
RequestIdstring

请求 ID。

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

请求是否执行成功:

  • 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错误码错误信息描述
400InvalidParamsThe request parameters are invalid.请求参数错误
403NoPermissionYou are not authorized to do this action.没有权限执行该操作

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

变更历史

变更时间变更内容概要操作
暂无变更历史