Listing All Backups (1.0.0)

Function

This API is used to list all backups.

URI

GET /v2/{project_id}/graphs/backups

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. For details about how to obtain a project ID, see Obtaining a Project ID. Constraints N/A Range The value can contain up to 64 characters. Only letters and digits are allowed. Default Value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Definition Maximum number of resources per page. Constraints N/A Range N/A Default Value 10
offset	No	Integer	Definition Starting position of the request. Constraints N/A Range N/A Default Value 0

Request Parameters

**Table 3** Request header parameter
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. It is used to obtain the permission to call APIs. For how to obtain the token, see Authentication. (The token is the value of X-Subject-Token in the response header.) Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
backup_count	Integer	Definition Total number of backups. This parameter is left blank when the request fails. Range N/A
backup_list	Array of backup_list objects	Definition List of all graph backups under the current project ID. This parameter is left blank when the request fails. Range N/A

**Table 5** backup_list
Parameter	Type	Description
id	String	Definition Backup ID. Range N/A
name	String	Definition Backup name. Range N/A
backup_method	String	Definition Backup method. Range auto: automatic backup. manual: manual backup. import: backup import.
graph_id	String	Definition ID of the graph associated with the backup. Range N/A
graph_name	String	Definition Name of the graph associated with the backup. Range N/A
graph_status	String	Definition Status of the graph associated with the backup. Range N/A
graph_size_type_index	String	Definition Size of the graph associated with the backup. Range N/A
data_store_version	String	Definition Version of the graph associated with the backup. Range N/A
arch	String	Definition CPU architecture of the graph associated with the backup. Range N/A
status	String	Definition Backup status. Range backing_up success failed
start_timestamp	Long	Definition Start timestamp of a backup job. Range N/A
start_time	String	Definition Start time of a backup job. Range N/A
product_type	String	Definition Graph product type. Range InMemory: memory edition. Persistence: database edition.
end_timestamp	Long	Definition End timestamp of a backup job. Range N/A
end_time	String	Definition End time of a backup job. Range N/A
size	Long	Definition Backup file size, in MB. Range N/A
duration	Long	Definition Backup duration, in seconds. Range N/A

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Definition System prompt. If the execution succeeds, this parameter may be left blank. If the execution fails, this parameter is used to display the error code. Range N/A
error_msg	String	Definition System prompt. If the execution succeeds, this parameter may be left blank. If the execution fails, this parameter is used to display the error message. Range N/A

Example Request

Query the list of all backups.

GET https://{Endpoint}/v2/{project_id}/graphs/backups?offset=0&limit=3

Example Response

Status code: 200

Example response for a successful request

{
  "backup_count" : 3,
  "backup_list" : [ {
    "id" : "ada3e720-ab87-48cb-bff7-3ec5ae1a9652",
    "name" : "ges060803_nodelete-20210608135513",
    "backup_method" : "manual",
    "graph_id" : "4c5f882d-a813-4d78-a8e3-6d3212ddd121",
    "graph_name" : "ges060803_nodelete",
    "graph_status" : "200",
    "graph_size_type_index" : "1",
    "data_store_version" : "2.2.21",
    "arch" : "x86_64",
    "status" : "success",
    "start_timestamp" : 1623160513000,
    "start_time" : "2021-06-08T13:55:13",
    "end_timestamp" : 1623160568000,
    "end_time" : "2021-06-08T13:56:08",
    "size" : 1,
    "duration" : 54
  }, {
    "id" : "7ed3f51d-816d-4651-9129-fe21b64b5c91",
    "name" : "ges060803_nodelete_20210609203323_auto",
    "backup_method" : "auto",
    "graph_id" : "4c5f882d-a813-4d78-a8e3-6d3212ddd121",
    "graph_name" : "ges060803_nodelete",
    "graph_status" : "200",
    "graph_size_type_index" : "1",
    "data_store_version" : "2.2.21",
    "arch" : "x86_64",
    "status" : "success",
    "start_timestamp" : 1623242004000,
    "start_time" : "2021-06-09T12:33:24",
    "end_timestamp" : 1623242004000,
    "end_time" : "2021-06-09T12:33:24",
    "size" : 1,
    "duration" : 0
  }, {
    "id" : "604bfb46-04dd-45fc-a9ae-df24a0705b9d",
    "name" : "ges060802_nodelete-20210608135523",
    "backup_method" : "manual",
    "graph_id" : "9b9a05c2-0cdb-41ac-b55f-93caffb0519a",
    "graph_name" : "ges060802_nodelete",
    "graph_status" : "400",
    "graph_size_type_index" : "0",
    "data_store_version" : "2.2.23",
    "arch" : "x86_64",
    "status" : "success",
    "start_timestamp" : 1623160524000,
    "start_time" : "2021-06-08T13:55:24",
    "end_timestamp" : 1623160577000,
    "end_time" : "2021-06-08T13:56:17",
    "size" : 1,
    "duration" : 53
  } ]
}

Status code: 400

Example response for a failed request

{
  "error_code" : "GES.7006",
  "error_msg" : "An internal error occurs in the underlying service of the graph engine."
}

Status Codes

Return Value	Description
400 Bad Request	Request error.
401 Unauthorized	Authorization failed.
403 Forbidden	No operation permissions.
404 Not Found	No resources found.
500 Internal Server Error	Internal server error.
503 Service Unavailable	Service unavailable.