文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 云办公服务/ 查询云办公服务是否被锁定
更新时间：2023-09-18 GMT+08:00
查看PDF
分享

查询云办公服务是否被锁定

功能介绍

查询云办公服务是否被锁定。

调试

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

URI

GET /v2/{project_id}/workspaces/lock-status

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

Content-Type

是

String

发送的实体的MIME类型。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

is_lock

Integer

云办公服务是否被锁定，0代表未锁定，1代表锁定。

lock_time

String

云办公服务锁定时间，格式：yyyy-MM-dd HH:mm:ss，时区：UTC。

lock_reason

String

云办公服务锁定原因。

状态码： 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

错误描述。

状态码： 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

GET /v2/8a2c3f8e71ed17c60171ed1fbf340000/workspaces/lock-status

响应示例

状态码： 200

查询云办公服务是否被锁定响应。

{
  "is_lock" : 1
}

状态码

状态码

描述

200

查询云办公服务是否被锁定响应。

400

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

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

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

错误码

请参见错误码。

父主题： 云办公服务

相关文档