Restore computing instance¶

Resume a paused compute instance. After success, the instance returns to IDLE, and the Worker will not be deployed immediately; the required Worker type will be activated only for subsequent workload requirements.

HTTP
POST $CLOUDSIGMA_API_BASE/compute-resources/{resource_id}/resume

Before you call this API¶

Configure the regional API endpoint and authentication, and select the target workspace.

First query the calculation instance details and confirm that the instance status is SUSPENDED.

Set the operation-specific values used in the request:

$RESOURCE_ID: Compute instance ID to restore.

Request¶

Input examples

Shell
curl -X POST "$CLOUDSIGMA_API_BASE/compute-resources/$RESOURCE_ID/resume" \
  -H "X-API-Key: $CLOUDSIGMA_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

Parameter reference

Path parameters

Parameter	Type	Required	Description
`resource_id`	string	Yes	Compute instance ID.

Successful response¶

When successful, 200 is returned, and data is the calculation instance object.

Response example

JSON
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "id": "cr-001",
    "name": "data-processing",
    "spec_id": "task-standard-small",
    "status": "IDLE",
    "status_message": "",
    "min_replicas": 0,
    "max_replicas": 2,
    "current_replicas": 0
  }
}

Field reference

The response fields are as follows.

Field	Type	Description
`code`	string	`OK` on success.
`msg`	string	`OK` on success.
`data.id`	string	Compute instance ID.
`data.workspace_id`	string	ID of the workspace to which it belongs.
`data.name`	string	Compute instance name.
`data.description`	string	Example description; returned when there is a value.
`data.spec_id`	string	Compute spec ID.
`data.kind`	string	Instance type.
`data.cpu`	integer	CPU configuration value.
`data.memory_gib`	integer	Configuration value expressed in GiB of memory.
`data.gpu`	integer	GPU configuration value.
`data.cpu_milli`	integer	CPU configuration value in millicores.
`data.memory_mib`	integer	Configuration value expressed in MiB of memory.
`data.gpu_count`	integer	Number of GPUs.
`data.gpu_memory_mib`	integer	MiB of video memory for a single GPU.
`data.gpu_cores`	integer	Number of GPU cores.
`data.min_replicas`	integer	Serverless instances are fixed to `0`.
`data.max_replicas`	integer	Maximum number of copies.
`data.desired_replicas`	integer	Number of target copies.
`data.current_replicas`	integer	The current number of copies.
`data.go_worker_image_id`	string	Go Worker image ID; returned if there is a value.
`data.python_worker_image_id`	string	Python Worker image ID; returned if there is a value.
`data.worker_images`	object[]	Worker image selection; returned when there is a value.
`data.worker_images[].worker_type`	string	Worker type.
`data.worker_images[].image_id`	string	Image ID.
`data.worker_images[].platform`	string	Running platform.
`data.platform`	string	Instance running platform; returned if there is a value.
`data.auto_suspend_minutes`	integer	Automatic pause waiting time.
`data.is_default`	boolean	Whether it is the default computing instance of the workspace.
`data.status`	string	`IDLE` on success.
`data.status_message`	string	Supplementary status information.
`data.scale_reason`	string	The scaling reason provided by the server; returned if there is a value.
`data.last_activation_at`	string	Last activation time; returned if there is a value.
`data.last_active_at`	string	Last active time; returned if there is a value.
`data.created_by`	string	Creator ID; returned if there is a value.
`data.created_at`	string	Creation time; returned if there is a value.
`data.updated_at`	string	Last updated time; returned if there is a value.

In this document, [] after a type means an array; for example, object[] is an array of objects. In field paths, [] means each item in an array; for example, data.worker_images[].worker_type is the worker_type field of each item in data.worker_images.

Error response¶

Response example

JSON
{
  "code": "RESUME_FAILED",
  "msg": "请求参数无效",
  "data": null
}

Field reference

Common HTTP errors¶

HTTP status code	error code	Common causes	Recommended actions
`400`	`RESUME_FAILED`	The instance ID is invalid or the current state does not allow recovery.	Check the instance details first, confirm the status and try again.
`401`	—	Missing or invalid access credentials.	Check the regional endpoint, API key, and workspace ID.
`403`	`ErrForbidden`	The current identity does not have instance operation permissions.	Requesting permission to `compute_resource.operate`.
`404`	`NOT_FOUND`	The instance does not exist or does not belong to the current workspace.	Check `resource_id` and workspace.
`409`	`ErrConflict`	The instance status conflicts with this operation.	Read the latest status before operating.
`500`	`RESUME_FAILED`	The server failed to process the restore request.	Try again later.

Follow-up operations¶

Query calculation instance details, and if necessary, Query Worker runtime.

Last updated on Sep 15, 2026