Function

This API is used to query the backup list of a graph.

URI

• URI format

  GET /v1.0/{project_id}/graphs/{graph_id}/backups?offset={offset}&limit={limit}

• Parameter description

  Table 1 URI parameter description

  Parameter	Mandatory	Type	Description
  project_id	Yes	String	Project ID, which is used for resource isolation. For details, see Obtaining a Project ID.
  graph_id	Yes	String	Graph ID
  offset	No	Integer	Start position of the request. The default value is 0.
  limit	No	Integer	Maximum number of resources displayed on a single page. The default value is 10.

Request

• Request example

  GET https://Endpoint/v1.0/{project_id}/graphs/{graph_id}/backups?offset=0&limit=2

Response

• Parameter description

  Table 2 Parameter description

  Parameter	Mandatory	Type	Description
  errorMessage	No	String	System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error message.
  errorCode	No	String	System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error code.
  backupCount	No	Integer	Total number of backups. This field is left blank when the request fails.
  backupList	No	GesBackUp set	List of backups of the specified graph under the current project. This parameter is left blank when the request fails.

  Table 3 GesBackUp data structure

  Parameter	Mandatory	Type	Description
  id	Yes	String	Backup ID
  name	Yes	String	Backup name
  backupMethod	Yes	String	Backup method. The value can be auto or manual.
  graphId	Yes	String	ID of the graph associated with the backup
  graphName	Yes	String	Name of the graph associated with the backup
  graphStatus	Yes	String	Status of the graph associated with the backup
  graphSizeTypeIndex	Yes	String	Size of the graph associated with the backup
  dataStoreVersion	Yes	String	Version of the graph associated with the backup
  arch	Yes	String	CPU architecture of the graph node associated with the backup
  status	Yes	String	Backup status: backing_up: indicates that a graph is being backed up. success: indicates that a graph is successfully backed up. failed: indicates that a graph fails to be backed up.
  startTimestamp	Yes	String	Start timestamp of a backup job
  startTime	Yes	String	Backup start time
  endTimestamp	Yes	String	End timestamp of a backup job
  endTime	Yes	String	Backup end time
  size	Yes	Long	Backup file size (MB)
  duration	Yes	Long	Backup duration (seconds)

• Response example

  {
      "backupCount": 2,
      "backupList": [
          {
              "id": "ada3e720-ab87-48cb-bff7-3ec5ae1a9652",
              "name": "ges060803_nodelete-20210608135513",
              "backupMethod": "manual",
              "graphId": "4c5f882d-a813-4d78-a8e3-6d3212ddd121",
              "graphName": "ges060803_nodelete",
              "graphStatus": "200",
              "graphSizeTypeIndex": "1",
              "dataStoreVersion": "2.2.22"
              "arch": "x86_64",
              "status": "success",
              "startTimestamp": 1623160513000,
              "startTime": "2021-06-08T13:55:13",
              "endTimestamp": 1623160568000,
              "endTime": "2021-06-08T13:56:08",
              "size": 1,
              "duration": 54
          },
          {
              "id": "7ed3f51d-816d-4651-9129-fe21b64b5c91",
              "name": "ges060803_nodelete_20210609203323_auto",
              "backupMethod": "auto",
              "graphId": "4c5f882d-a813-4d78-a8e3-6d3212ddd121",
              "graphName": "ges060803_nodelete",
              "graphStatus": "200",
              "graphSizeTypeIndex": "1",
              "dataStoreVersion": "2.2.21"
              "arch": "x86_64",
              "status": "success",
              "startTimestamp": 1623242004000,
              "startTime": "2021-06-09T12:33:24",
              "endTimestamp": 1623242004000,
              "endTime": "2021-06-09T12:33:24",
              "size": 1,
              "duration": 0
          }
      ]
  }

• Response example (failed request)

   Http Status: 400
  {
      "errorCode": "GES.7000",
      "errorMessage": "The graph does not exist or has been deleted."
  }

Return Value

• Normal

  200

• Abnormal

  Table 4 Return code for failed requests

  Return Value	Description
  400 Bad Request	Request error.
  401 Unauthorized	Authentication failed.
  403 Forbidden	No operation permission.
  404 Not Found	The requested resource was not found.
  500 Internal Server Error	Internal service error.
  503 Service Unavailable	Service unavailable.