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 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

GET /v1.0/89cd04f168b84af6be287f71730fdb4b/snapshots

Response Message

• Sample 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"
          }
      ]
  }

• Parameter description

  Table 2 Response parameter description

  Parameter	Type	Description
  snapshots	Array of Snapshots objects	List of snapshot objects

  Table 3 Snapshots

  Parameter	Type	Description
  cluster_id	String	ID of the cluster for which a snapshot is created
  size	Double	Snapshot size, in GB.
  name	String	Snapshot name
  description	String	Snapshot description
  finished	String	Time when a snapshot has been created. The format is ISO8601: YYYY-MM-DDThh:mm:ssZ.
  started	String	Time when a snapshot is being created.
  id	String	Snapshot ID
  type	String	Snapshot type
  status	String	Snapshot status

Status Code

• Normal

  200

• Abnormal

  Table 4 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.