Updated on 2025-11-18 GMT+08:00

Freezing a Workspace

Function

This API is used to freeze a workspace.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/{instance_id}/workspace/{workspace_id}/frozen-workspace

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain it, see Project ID and Account ID.

instance_id

Yes

String

Instance ID. For details about how to obtain it, see Instance ID and Workspace ID.

workspace_id

Yes

String

Workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. This parameter is mandatory when token authentication is used. You can obtain it from the value of X-Subject-Token in the response message header returned by the "Obtaining a User Token" API of the IAM service.

Response Parameters

Status code: 200

Success: The workspace is frozen successfully.

Status code: 400

Table 3 Response body parameters

Parameter

Type

Description

error_msg

String

Returned error information.

error_code

String

Returned error code.

Status code: 500

Table 4 Response body parameters

Parameter

Type

Description

error_msg

String

Returned error information.

error_code

String

Returned error code.

Example Requests

None

Example Responses

Status code: 400

Bad request.

{
  "error_code" : "DAYU.4402",
  "error_msg" : "The operation failed, detail msg {0}."
}

Status code: 500

Internal server error.

{
  "error_code" : "DAYU.3531",
  "error_msg" : "Internal server error: {0}"
}

Status Codes

Status Code

Description

200

Success: The workspace is frozen successfully.

400

Bad request.

500

Internal server error.