Help Center> Workspace> API Reference> Workspace APIs> Huawei Cloud Workspace> Queries whether Huawei Cloud Workspace is locked.
Updated on 2024-01-10 GMT+08:00

Queries whether Huawei Cloud Workspace is locked.

Function

Queries whether Huawei Cloud Workspace is locked.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API that is used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Content-Type

Yes

String

MIME type of the request body.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

is_lock

Integer

Whether Huawei Cloud Workspace is locked. The value 0 indicates unlocked and the value 1 indicates locked.

lock_time

String

Time when Huawei Cloud Workspace is locked. The format is yyyy-MM-dd HH:mm:ss. The time zone is UTC.

lock_reason

String

Cause for locking Huawei Cloud Workspace.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

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

Example Responses

Status code: 200

Response to the request for querying whether Huawei Cloud Workspace is locked.

{
  "is_lock" : 1
}

Status Codes

Status Code

Description

200

Response to the request for querying whether Huawei Cloud Workspace is locked.

400

The request cannot be understood by the server due to malformed syntax.

401

Authentication failed.

403

You do not have required permissions.

404

No resource found.

500

An internal service error occurred. For details about the error code, see the error code description.

Error Codes

See Error Codes.