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

Creating a Snapshot Consistency Group

Function

This API is used to create a snapshot consistency group. Standard snapshots are available only in some regions. To check the supported regions, see the region information shown under "EVS Snapshots" in Function Overview

Calling Method

For details, see Calling APIs.

URI

POST /v5/{project_id}/snapshot-groups

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

The project ID.

Constraints

N/A

Range

For details, see Obtaining a Project ID.

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_group

Yes

SnapshotGroup object

Information about the snapshot consistency group to be created.
Table 4 SnapshotGroup

Parameter

Mandatory

Type

Description

server_id

No

String

The server ID.

volume_ids

No

Array of strings

The disk IDs. The value is in the ['id1','id2',...,'idx'] format.

If server_id is specified, you can only use this parameter to specify disks that are attached with the specified server. Disks on other servers cannot be specified.

instant_access

No

Boolean

Whether to enable Instant Snapshot Restore. Value options:

true: enable

false: disable

The default value is false.

name

No

String

The name of the snapshot consistency group. It can contain a maximum of 255 bytes.

Minimum length: 0

Maximum length: 255

description

No

String

The description of the snapshot consistency group. It can contain a maximum of 255 bytes.

Minimum length: 0

Maximum length: 255

tags

No

Map<String,String>

The tags of the snapshot consistency group.

enterprise_project_id

No

String

The ID of the enterprise project where the snapshot consistency group belongs.

incremental

No

Boolean

Whether to create the incremental snapshot.

Response Parameters

Status code: 202

Table 5 Response body parameters

Parameter

Type

Description

job_id

String

The task ID.

snapshot_group_id

String

The ID of the snapshot consistency group.

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 codes and their meanings, see Error Codes.

message

String

Definition

The error message returned if an error occurs.

Range

N/A

Example Requests

None

Example Responses

Status code: 202

Accepted

{
  "job_id" : "XXXXX",
  "snapshot_group_id" : "XXXXXX"
}

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.