文档首页/ 云桌面 Workspace/ API参考/ 云应用API/ 使用记录/ 用户会话注销
更新时间：2025-11-11 GMT+08:00
查看PDF
分享

用户会话注销

功能介绍

用户会话注销。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v1/{project_id}/session/logoff

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

session_ids

是

Array of strings

会话信息id列表。

message_type

是

Integer

客户端弹框级别，代表给会话发消息时的严重程度（比如info、warning、error级别） 0->info; 1-> warn; 2->serious。

message

否

String

客户端弹框内容。

title

否

String

弹框标题。

delay_time

是

Integer

延迟多长时间注销会话， 单位：秒。

transaction_id

否

String

事务id，用作客户端日志定位跟踪。

响应参数

状态码：200

成功响应。

状态码：400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：401

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：403

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：404

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：405

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：415

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：503

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

请求示例

POST /v1/a4da8115c9d8464ead3a38309130523f/session/logoff

{
  "session_ids" : [ "1baaff74364c441f8c189fdcba427f82" ],
  "message_type" : "1",
  "message" : "会话注销",
  "title" : "会话注销",
  "delay_time" : 10,
  "transaction_id" : "35998d9a-14f2-48fc-832b-6fc0074dc8f8"
}

响应示例

无

状态码

状态码

描述

200

成功响应。

400

由于包含语法错误，当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

405

请求中指定的方法不被允许。

415

请求中提交的资源格式不支持。

500

服务内部错误，具体返回错误码请参见错误码说明。

503

服务不可用。

错误码

请参见错误码。

父主题： 使用记录

相关文档