Creating a Snapshot

Function

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

URI

• URI format

  POST /v1.0/{project_id}/snapshots

• Parameter description

  Table 1 URI parameter description

  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 Message

• Sample request

  POST /v1.0/89cd04f168b84af6be287f71730fdb4b/snapshots
  {
      "snapshot": {
         "name": "snapshot-3",
         "cluster_id": "44b277eb-39be-4921-be31-3d61b43651d7",
         "description": "Snapshot-3 description"
       }
  }

• Parameter description

  Table 2 Request parameter description

  Parameter	Mandatory	Type	Description
  snapshot	Yes	Snapshot object	Snapshot object

  Table 3 Snapshot

  Parameter	Mandatory	Type	Description
  cluster_id	Yes	String	ID of the cluster for which you want to create a snapshot
  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.
  description	No	String	Snapshot description. If no value is specified, the description is empty.

Response Message

• Sample response

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

• Parameter description

  Table 4 Response parameter description

  Parameter	Type	Description
  snapshot	SnapshotResp object	Snapshot object

  Table 5 SnapshotResp

  Parameter	Type	Description
  id	String	Snapshot ID

Status Code

• Normal

  200

• Abnormal

  Table 6 Returned value description

  Returned Value	Description
  400 Bad Request	Request error.
  401 Unauthorized	Authentication failed.
  403 Forbidden	You do not have the permission to perform the operation.
  404 Not Found	The requested resource was not found.
  500 Internal Server Error	Internal service error.
  503 Service Unavailable	The service is unavailable.