Help Center/ Elastic Volume Service/ API Reference/ API/ Standard Snapshot Management/ Creating a Snapshot
Updated on 2025-11-25 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Creating a Snapshot

Function

This API is used to create a standard snapshot. Standard snapshots are only supported in some regions. You can check the supported regions on the console.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

POST /v5/{project_id}/snapshots

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

The project ID. For details, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

The 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.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

snapshot

Yes

CreateStandardSnapshot object

Definition

The request body for creating a standard snapshot.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 4 CreateStandardSnapshot

Parameter

Mandatory

Type

Description

volume_id

No

String

Definition

The disk ID.

You can call the Querying Details About All EVS Disks API to obtain the disk ID.

Constraints

N/A

Range

N/A

Default Value

N/A

name

No

String

Definition

The snapshot name.

You can call the Querying Details About EVS Snapshots API to obtain the snapshot name.

Constraints

N/A

Range

It can contain a maximum of 64 characters.

Default Value

N/A

description

No

String

Definition

The snapshot description.

Constraints

N/A

Range

It can contain a maximum of 85 characters.

Default Value

N/A

tags

No

Map<String,String>

Definition

The snapshot tags.

Constraints

N/A

Range

N/A

Default Value

N/A

enterprise_project_id

No

String

Definition

The ID of the enterprise project to which the snapshot belongs.

For more information about enterprise projects and how to obtain enterprise project IDs, see Enterprise Management User Guide.

Constraints

N/A

Range

N/A

Default Value

0: the default enterprise project

instant_access

No

Boolean

Whether to enable Instant Snapshot Restore. The default value is false, indicating not enable the function.

incremental

No

Boolean

Definition

Whether to create an incremental snapshot.

Constraints

N/A

Range

  • true: creates an incremental snapshot.

  • false: creates a full snapshot.

Default Value

true

Response Parameters

Status code: 202

Table 5 Response body parameters

Parameter

Type

Description

job_id

String

Definition

The task ID.

For details about how to query the task status, see Querying Task Status.

Range

N/A

snapshot_id

String

Definition

The snapshot ID.

Range

N/A

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error

Error object

Definition

The error information returned if an error occurs.

Range

N/A
Table 7 Error

Parameter

Type

Description

code

String

Definition

The error code returned if an error occurs.

Range

For details about the error code, see Error Codes.

message

String

Definition

The error message returned if an error occurs.

Range

N/A

Example Requests

POST https://{endpoint}/v5/{project_id}/snapshots

{
  "snapshot" : {
    "volume_id" : "2c194dde-7de5-4529-a141-49f48181f411",
    "name" : "test_name",
    "description" : "test description",
    "enterprise_project_id" : "94f1ea84-1428-49b6-9920-8a9b8a29e4ca"
  }
}

Example Responses

Status code: 202

Accepted

{
  "job_id" : "ee62a0c1e79c4e11be5adc17a49f69ef",
  "snapshot_id" : "bb02c803-55ac-4e84-9c80-60d352199d7d"
}

Status code: 400

Bad Request

{
  "error" : {
    "message" : "XXXX",
    "code" : "EVS.XXX"
  }
}

Status Codes

Status Code

Description

202

Accepted

400

Bad Request

Error Codes

See Error Codes.