Help Center/ Data Warehouse Service/ API Reference/ API Description/ Snapshot Management/ Copying a Snapshot
Updated on 2025-08-06 GMT+08:00
View PDF

Copying a Snapshot

Function

This API is used to copy an automated snapshot.

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/{project_id}/snapshots/{snapshot_id}/linked-copy

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

snapshot_id

Yes

String

Definition

Snapshot ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

backup_name

Yes

String

Definition

Snapshot name.

Range

N/A

description

No

String

Definition

Description.

Range

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

snapshot_id

String

Definition

Snapshot ID.

Range

N/A

Example Requests

Copy an automated snapshot. The snapshot name is test1.

POST https://{Endpoint} /v1.0/89cd04f168b84af6be287f71730fdb4b/snapshots/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/linked-copy

{
  "backup_name" : "backup20",
  "description" : "description"
}

Example Responses

Status code: 200

Operation succeeded.

{
  "snapshot_id" : "4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba92"
}

Status Codes

Status Code

Description

200

Operation succeeded.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

Service unavailable.
Parent Topic: Snapshot Management