调用CreateKillInstanceSessionTask创建结束会话的任务_数据库自治服务(DAS)-阿里云帮助中心

调用CreateKillInstanceSessionTask接口，创建结束会话的任务。

接口说明

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

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
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	long	返回的状态码。	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.	没有权限执行该操作

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

变更历史

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

暂无变更历史