Querying the Snapshot List

Function

This API is used to query the snapshot list.

URI

• URI format

  GET /v1.0/{project_id}/snapshots

• Parameter description

  Table 1 URI parameters

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

Request Message

Request example

GET /v1.0/89cd04f168b84af6be287f71730fdb4b/snapshots

Response Message

• Example response

  status CODE 200
  {
      "snapshots": [
          {
              "id": "2a4d0f86-67cd-408a-8b66-017454fb7793",
              "name": "snapshot-1",
              "description": "",
              "started": "2016-08-23T03:59:23Z",
              "finished": "2016-08-23T04:01:40Z", 
              "size": 500,
              "status": "AVAILABLE",
              "type": "MANUAL",
              "cluster_id": "4f87d3c4-9e33-482f-b962-e23b30d1a18c"
          },
          {
              "id": "4af11460-06ec-48a4-b3ad-0e3bbdcd8ab1",
              "name": "snapshot-2",
              "description": "",
              "started": "2016-08-23T18:20:00Z",
              "finished": "2016-08-23T18:22:12Z",
              "size": 500,
              "status": "AVAILABLE",
              "type": "MANUAL",
              "cluster_id": "4f87d3c4-9e33-482f-b962-e23b30d1a18c"
          }
      ],
         "count":2
  }

• Parameter description

  Table 2 Response parameter description

  Parameter	Type	Description
  snapshots	Array of Snapshots objects	List of snapshot objects
  count	Integer	Total number of snapshot objects

  Table 3 Snapshots

  Parameter	Type	Description
  id	String	Snapshot ID
  name	String	Snapshot name
  description	String	Snapshot description
  started	String	Time when a snapshot starts to be created. Format: ISO8601: YYYY-MM-DDThh:mm:ssZ
  finished	String	Time when a snapshot is complete. Format: ISO8601: YYYY-MM-DDThh:mm:ssZ
  size	Double	Snapshot size, in GB
  status	String	Snapshot status: CREATING AVAILABLE UNAVAILABLE
  type	String	Snapshot type. It can be: MANUAL AUTOMATED
  cluster_id	String	ID of the cluster for which snapshots are created. For details about how to obtain the ID, see Obtaining the Cluster ID.

Status Code

• Normal

  200

• Exception

  Table 4 Returned values

  Returned Value	Description
  400 Bad Request	Request error.
  401 Unauthorized	Authorization failed.
  403 Forbidden	No operation permission.
  404 Not Found	No resources found.
  500 Internal Server Error	Internal service error.
  503 Service Unavailable	The service is unavailable.