更新时间:2025-12-29 GMT+08:00

kill指定的会话

功能介绍

kill指定的会话。

URI

POST /v2/{project_id}/instances/{instance_id}/clients/kill

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。获取方法请参见获取项目ID

instance_id

String

实例ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

node_id

String

节点ID。

client_addrs

Array of strings

要kill的会话地址列表,取值为会话信息中peer的地址和端口。

响应参数

状态码:204

kill指定的会话成功。

状态码:400

表3 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

error_ext_msg

String

扩展错误信息。

状态码:401

表4 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

error_ext_msg

String

扩展错误信息。

状态码:403

表5 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

error_ext_msg

String

扩展错误信息。

状态码:404

表6 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

error_ext_msg

String

扩展错误信息。

状态码:500

表7 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

error_ext_msg

String

扩展错误信息。

请求示例

POST https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/clients/kill

{
  "node_id" : "8f7ee181-88e2-49b7-a4bf-81f18f93a135",
  "client_addrs" : [ "10.63.238.158:2048", "10.63.238.159:3058" ]
}

响应示例

状态码:400

非法请求。

{
  "error_code" : "DCS.4957",
  "error_msg" : "This operation is not allowed when the task is in the current state."
}

状态码

状态码

描述

204

kill指定的会话成功。

400

非法请求。

401

认证信息非法。

403

请求被拒绝访问。

404

所请求的资源不存在。

500

内部服务错误。

错误码

请参见错误码