批量注销桌面
功能介绍
批量注销桌面(仅支持容器桌面,待下线,有疑问请联系管理员)。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v2/{project_id}/desktops/logoff
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
项目ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
Content-Type |
否 |
String |
发送的实体的MIME类型。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
desktop_ids |
否 |
Array of strings |
计算机id列表。 |
message |
否 |
String |
下发注销桌面任务时，给用户发送的提示信息。 |
响应参数
状态码： 400
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码，失败时返回。 |
error_msg |
String |
错误描述。 |
状态码： 401
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码，失败时返回。 |
error_msg |
String |
错误描述。 |
状态码： 403
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码，失败时返回。 |
error_msg |
String |
错误描述。 |
状态码： 404
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码，失败时返回。 |
error_msg |
String |
错误描述。 |
状态码： 409
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码，失败时返回。 |
error_msg |
String |
错误描述。 |
状态码： 500
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码，失败时返回。 |
error_msg |
String |
错误描述。 |
请求示例
{
"desktop_ids" : [ "string" ],
"image_type" : "string",
"image_id" : "string",
"os_type" : "string",
"delay_time" : "integer",
"message" : "string"
}
响应示例
状态码： 200
正常，无响应体。
null
状态码
状态码 |
描述 |
|---|---|
200 |
正常，无响应体。 |
400 |
由于包含语法错误，当前请求无法被服务器理解。 |
401 |
鉴权失败。 |
403 |
没有操作权限。 |
404 |
找不到资源。 |
409 |
操作冲突。 |
500 |
服务内部错误，具体返回错误码请参见错误码说明。 |
错误码
请参见错误码。
