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

Updating a Snapshot Consistency Group

Function

This API is used to update 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

PUT /v5/{project_id}/snapshot-groups/{snapshot_group_id}

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

snapshot_group_id

Yes

String

The snapshot consistency group ID.

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

UpdateSnapshotGroupResponseBody object

The snapshot consistency group to be updated.
Table 4 UpdateSnapshotGroupResponseBody

Parameter

Mandatory

Type

Description

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

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

snapshot_group

SnapshotGroupDetail object

The updated snapshot consistency group information.
Table 6 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 7 Response body parameters

Parameter

Type

Description

error

Error object

Definition

The error information returned if an error occurs.

Range

N/A
Table 8 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

PUT https://{endpoint}/v5/{project_id}/snapshot-groups/{snapshot_group_id}

{
  "snapshot_group": {
    "name": "snap-group-001",
    "description": "test",
  }
}

Example Responses

Status code: 200

OK

{
  "snapshot_group" : {
    "id" : "5e0fc839-9a2f-4d45-8ae5-a54859083673",
    "server_id" : null,
    "project_id" : "060576838600d5762f2dc000470eb164",
    "enterprise_project_id" : "0",
    "name" : "test_ssg_name",
    "description" : "test_ssg_description",
    "status" : "available",
    "tags" : {
      "this_is_test_key" : "this_is_test_value"
    },
    "created_at" : "2024-02-17T02:58:48.583012",
    "updated_at" : "2024-02-17T02:58:48.736012"
  }
}

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.