删除单个桌面 - DeleteDesktop
功能介绍
删除单个桌面，删除后无法恢复。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
DELETE /v2/{project_id}/desktops/{desktop_id}
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 项目ID。 |
desktop_id | 是 | String | 桌面ID。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
delete_users | 否 | Boolean | 删除桌面后，如果当前用户没有其它桌面，可以删除桌面用户。true：删除用户，false：不删除用户，默认为false。 |
email_notification | 否 | Boolean | 删除桌面后，是否给桌面用户发送系统通知邮件。true：发送，false：不发送。默认为true。 |
is_force_delete | 否 | Boolean | 是否强制删除。 |
请求参数
无
响应参数
状态码：204
正常，无响应体。
状态码：400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码，失败时返回。 |
error_msg | String | 错误描述。 |
error_detail | String | 错误详情。 |
encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码：401
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码，失败时返回。 |
error_msg | String | 错误描述。 |
error_detail | String | 错误详情。 |
encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码：403
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码，失败时返回。 |
error_msg | String | 错误描述。 |
error_detail | String | 错误详情。 |
encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码：404
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码，失败时返回。 |
error_msg | String | 错误描述。 |
error_detail | String | 错误详情。 |
encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码：409
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码，失败时返回。 |
error_msg | String | 错误描述。 |
error_detail | String | 错误详情。 |
encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码：500
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码，失败时返回。 |
error_msg | String | 错误描述。 |
error_detail | String | 错误详情。 |
encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
请求示例
DELETE /v2/0bec5db98280d2d02fd6c00c2de791ce/desktops/a130ab3a-72bf-4b71-baa9-af4987c8e338
响应示例
无
状态码
状态码 | 描述 |
|---|---|
204 | 正常，无响应体。 |
400 | 由于包含语法错误，当前请求无法被服务器理解。 |
401 | 鉴权失败。 |
403 | 没有操作权限。 |
404 | 找不到资源。 |
409 | 操作冲突。 |
500 | 服务内部错误，具体返回错误码请参见错误码说明。 |
错误码
请参见错误码。
