下发kill指定节点或实例的全部会话任务
功能介绍
下发kill指定节点或实例的全部会话任务。
URI
POST /v2/{project_id}/instances/{instance_id}/clients/kill-all
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID。获取方法请参见获取项目ID。 |
| instance_id | 是 | String | 实例ID。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| node_id | 否 | String | 指定要kill全部会话的节点ID，删除所有节点为false时必填。 |
| kill_all_nodes | 否 | Boolean | true：Kill实例全部节点的会话。 false: kill指定节点的全部会话。 |
响应参数
状态码：200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| job_id | String | 下发kill指定节点或实例的任务ID。 |
状态码：400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_msg | String | 错误信息。 |
| error_code | String | 错误码。 |
| error_ext_msg | String | 扩展错误信息。 |
状态码：401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_msg | String | 错误信息。 |
| error_code | String | 错误码。 |
| error_ext_msg | String | 扩展错误信息。 |
状态码：403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_msg | String | 错误信息。 |
| error_code | String | 错误码。 |
| error_ext_msg | String | 扩展错误信息。 |
状态码：404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_msg | String | 错误信息。 |
| error_code | String | 错误码。 |
| error_ext_msg | String | 扩展错误信息。 |
状态码：500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_msg | String | 错误信息。 |
| error_code | String | 错误码。 |
| error_ext_msg | String | 扩展错误信息。 |
请求示例
{
"node_id" : "8f7ee181-88e2-49b7-a4bf-81f18f93a135",
"kill_all_nodes" : true
} 响应示例
状态码：200
下发kill指定节点或实例的全部会话任务成功。
{
"job_id" : "8abf6e1e824dfcb201824e02ee9a0015"
} 状态码：400
非法请求。
{
"error_code" : "DCS.4957",
"error_msg" : "This operation is not allowed when the task is in the current state."
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 下发kill指定节点或实例的全部会话任务成功。 |
| 400 | 非法请求。 |
| 401 | 认证信息非法。 |
| 403 | 请求被拒绝访问。 |
| 404 | 所请求的资源不存在。 |
| 500 | 内部服务错误。 |
错误码
请参见错误码。
