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

Listing Snapshot Consistency Groups

Function

This API is used to list snapshot consistency groups. 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

GET /v5/{project_id}/snapshot-groups/detail

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
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

id

No

String

The ID of the snapshot consistency group.

name

No

String

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

Minimum length: 0

Maximum length: 255

status

No

String

The status of the snapshot consistency group. The value can be as follows:

creating: being created

available: created

error: creation failed

deleting: being deleted

tag_key

No

String

The tag key of the snapshot consistency group.

tags

No

String

The key-value pairs of the snapshot consistency group tags, for example, {"key1":"value1"}.

enterprise_project_id

No

String

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

limit

No

Integer

The maximum number of query results that can be returned.

offset

No

Integer

The query offset.

sort_key

No

String

The keyword based on which the returned results are sorted. The value can be id, status, size, or created_at, and the default value is created_at.

sort_dir

No

String

The result sorting order. The value can be asc (the ascending order) or desc (the descending order). The default value is desc.

server_id

No

String

The server ID.

Request Parameters

Table 3 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

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

snapshot_groups

Array of SnapshotGroupDetail objects
Table 5 SnapshotGroupDetail

Parameter

Type

Description

id

String

The ID of the snapshot consistency group.

created_at

String

The time when the snapshot consistency group was created.

status

String

The status of the snapshot consistency group.

updated_at

String

The time when the snapshot consistency group was updated.

name

String

The name of the snapshot consistency group.

description

String

The description of the snapshot consistency group.

enterprise_project_id

String

The ID of the enterprise project to which the snapshot consistency group is added to.

tags

Map<String,String>

The tags of the snapshot consistency group.

server_id

String

The server ID.

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: 200

OK

{
  "snapshot_groups" : [ {
    "id" : "82700157-fa53-46bf-a51f-255624275cbe",
    "name" : "testSnapshotGroup",
    "description" : "test",
    "project_id" : "dae4ff26f73b4b3395a0f650a979beae",
    "enterprise_project_id" : "testEpId",
    "status" : "available",
    "tags" : {
      "key1" : "value1",
      "key2" : "value2",
      "key3" : "value3"
    },
    "created_at" : "2025-04-10T09:40:12.204112",
    "updated_at" : "2025-04-10T09:40:12.607112",
    "server_id" : null
  } ]
}

Status code: 400

Bad Request

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

Status Codes

Status Code

Description

200

OK

400

Bad Request

Error Codes

See Error Codes.