批量删除桌面
功能介绍
批量删除桌面，删除后无法恢复。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v2/{project_id}/desktops/batch-delete
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
项目ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
Content-Type |
否 |
String |
发送的实体的MIME类型。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
desktop_ids |
是 |
Array of strings |
待删除的桌面ID列表。 |
delete_users |
否 |
Boolean |
删除桌面后，如果当前用户没有其它桌面，可以删除桌面用户。true：删除用户，false：不删除用户，默认为false。 |
email_notification |
否 |
Boolean |
是否邮件通知，true：邮件通知，false：不通知，默认值true。 |
is_force_delete |
否 |
Boolean |
是否强制删除，true：强制删除，false：不强制删除 |
响应参数
状态码： 202
参数 |
参数类型 |
描述 |
|---|---|---|
job_id |
String |
任务ID。 |
状态码： 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" : [ "1d81c1dc-312b-4621-b778-bac3a1336442", "34e25501-fd50-42b5-97ca-f4c5bb7b09b0" ]
}
响应示例
状态码： 202
正常
{
"job_id" : "abc85365-0b2e-4b4f-a091-f7db72072d4b"
}
状态码
状态码 |
描述 |
|---|---|
202 |
正常 |
400 |
由于包含语法错误，当前请求无法被服务器理解。 |
401 |
鉴权失败。 |
403 |
没有操作权限。 |
404 |
找不到资源。 |
409 |
操作冲突。 |
500 |
服务内部错误，具体返回错误码请参见错误码说明。 |
错误码
请参见错误码。
