Help Center/ Workspace/ API Reference/ Workspace APIs/ Snapshot/ Creating Snapshots in Batches

Updated on 2025-07-14 GMT+08:00

View PDF

Creating Snapshots in Batches

Function

Creates snapshots in batches.

Debugging

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

URI

POST /v2/{project_id}/snapshots/batch-create

**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	No	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
desktop_ids	No	Array of strings	Desktop ID array. A maximum of 100 desktop IDs are supported.
disk_type	No	String	Snapshot type: SYSTEM_DISK: system disk DATA_DISKS: data disk ALL: system disk and data disk
system_disk_snapshot	No	DiskSnapshotInfo object	Disk snapshot information.
data_disk_snapshot	No	DiskSnapshotInfo object	Disk snapshot information.

**Table 4** DiskSnapshotInfo
Parameter	Mandatory	Type	Description
name	No	String	Disk snapshot name. The name of a batch operation is in the format of desktop name + disk snapshot name + timestamp.
description	No	String	Disk snapshot description.

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
job_id	String	Task ID.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 409

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: default

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

{
  "desktop_ids" : [ "xxxx3bc6-1512-4386-81fb-20604fe6xxxx" ],
  "disk_type" : "string",
  "system_disk_snapshot" : {
    "name" : "string",
    "description" : "string"
  },
  "data_disk_snapshot" : {
    "name" : "string",
    "description" : "string"
  }
}

Example Responses

Status code: 200

OK.

{
  "job_id" : "1792d3eb-35c6-4e99-8381-abfc8e02126b"
}

Status Codes

Status Code	Description
200	OK.
400	The request cannot be understood by the server due to malformed syntax.
404	No resources found.
409	Operation conflict.
500	An internal service error occurred. For details, see the error code description.
default	Default response to a failure.