全部产品
Search
文档中心

云数据库 OceanBase:KillProcessList - 关闭指定的会话

更新时间:Oct 23, 2024

关闭指定的会话。

接口说明

为优化用户体验,云数据库对会话功能进行了升级,本接口将下线并由新的接口替代,详情请参见 【通知】云数据库会话管理 API 接口变更说明

调试

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

授权信息

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

请求参数

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

OceanBase 集群 ID。

ob317v4uif****
SessionListstring

需要关闭的会话列表。

[ { "ServerIp": "192.***.**.***", "SessionId": "322161****" } ]
TenantIdstring

租户 ID。

t4louaeei****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

EE205C00-30E4-****-****-87E3A8A2AA0C
Dataarray<object>

返回数据。

Dataobject

请求返回的信息。

SessionIdlong

会话 ID。

1123
ServerIpstring

服务器 IP。

127.*.*.*
Statusstring

任务状态。

SLEEP
ErrorMessagestring

错误信息。

Instance not found.
ClientIpstring

客户端 IP。

127.*.*.*
TenantIdstring

租户 ID。

t3ogq******n4
Userstring

数据库用户名。

oas
Databasestring

数据库名称。

test
SqlTextstring

SQL 语句。

:
Commandstring

应用容器启动命令。

select 1
ExecuteTimestring

执行时间 (UTC+8),为空立即执行。

142

示例

正常返回示例

JSON格式

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Data": [
    {
      "SessionId": 1123,
      "ServerIp": "127.*.*.*",
      "Status": "SLEEP",
      "ErrorMessage": "Instance not found.",
      "ClientIp": "127.*.*.*",
      "TenantId": "t3ogq******n4",
      "User": "oas",
      "Database": "test",
      "SqlText": ":",
      "Command": "select 1",
      "ExecuteTime": "142"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
2014InternalErrorThe request processing has failed due to some unknown error.内部错误

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

变更历史

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