doc-exports/docs/dws/api-ref/dws_02_0026.html

Creating a Snapshot

Function

This API is used to create snapshots for a specified cluster.

URI

POST /v1.0/{project_id}/snapshots

Table 1 URI parameters

Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

Table 2 Request body parameters

Parameter	Mandatory	Type	Description
snapshot	Yes	Snapshot object	Snapshot object

Table 3 Snapshot

Parameter	Mandatory	Type	Description
name	Yes	String	Snapshot name, which must be unique and start with a letter. It consists of 4 to 64 characters, which are case-insensitive and contain letters, digits, hyphens (-), and underscores (_) only.
cluster_id	Yes	String	ID of the cluster for which you want to create a snapshot. For details about how to obtain the ID, see Obtaining the Cluster ID.
description	No	String	Snapshot description. If no value is specified, the description is empty. Enter a maximum of 256 characters. The following special characters are not allowed: !<>'=&"

Response Parameters

Table 4 Response body parameters

Parameter	Type	Description
snapshot	SnapshotResp object	Snapshot object

Table 5 SnapshotResp

Parameter	Type	Description
id	String	Snapshot ID

Example Request

POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/snapshots

{
  "snapshot" : {
    "name" : "snapshot-3",
    "cluster_id" : "44b277eb-39be-4921-be31-3d61b43651d7",
    "description" : "Snapshot-3 description"
  }
}

Example Response

{
    "snapshot": {
        "id": "2a4d0f86-67cd-408a-8b66-017454fb7793"
    }
}

Status Code

Status Code	Description
200	The snapshot is created.
400	Request error.
401	Authentication failed.
403	You do not have required permissions.
404	No resources found.
500	Internal service error.
503	Service unavailable.

Parent topic: Snapshot Management APIs