调用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 时，请求参数 IgnoredUsers 中账号的会话、阿里云内部运维账号的会话和Binlog Dump会话都不会被结束。
| true |
| SessionIds | string | 否 | 需要被结束的会话 ID 列表。 说明
数据格式为 JSONArray，例如[会话 ID1,会话 ID2]，会话 ID 间用英文逗号（,）分隔。如果请求参数 KillAllSessions 取值为 true（即结束全部会话），该列表会被忽略。
| [10805639,10805623,10805645,10805553,10805566,10805616] |
返回参数
示例
正常返回示例
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. | 没有权限执行该操作 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史