Viewing the List of All Backups (1.0.0)

Function

This API is used to query the list of all backups.

URI

GET /v1.0/{project_id}/graphs/backups

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Maximum number of resources displayed on a single page. The default value is 10.
offset	No	Integer	Start position of the request. The default value is 0.

Request Parameters

**Table 3** Parameters in the request header
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It is used to obtain the permission to call APIs. For details about how to obtain the token, see Authentication. The value of X-Subject-Token in the response header is the token.

Response Parameters

Status code: 200

**Table 4** Response body parameter
Parameter	Type	Description
errorMessage	String	System prompt code. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error message.
errorCode	String	System prompt code. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error code.
backupCount	Integer	Total number of backups. This parameter is left blank if the request fails.
backupList	Array of backup objects	List of all backups under the current project ID. This parameter is left blank if the request fails.

**Table 5** backup
Parameter	Type	Description
id	String	Backup ID
name	String	Backup name
backupMethod	String	Backup method. The value can be auto or manual.
graphId	String	ID of the graph associated with the backup
graph_name	String	Name of the graph associated with the backup
graphStatus	String	Status of the graph associated with the backup
graphSizeTypeIndex	String	Size of the graph associated with the backup
dataStoreVersion	String	Version of the graph associated with the backup
arch	String	CPU architecture of the graph node associated with the backup
status	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	Long	Start timestamp of a backup job
startTime	String	Backup start time
endTimestamp	Long	End timestamp of a backup job
endTime	String	Backup end time
size	Long	Backup file size (MB)
duration	Long	Backup duration (seconds)
encrypted	Boolean	Whether to encrypt backup data. true: The backups will be encrypted; value: The backups will not be encrypted. The default value is false.

Example Request

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

Example Response

Example response with status code 200:

{
    "backupCount": 3,
    "backupList": [
        {
            "id": "ada3e720-ab87-48cb-bff7-3ec5ae1a9652",
            "name": "ges060803_nodelete-20210608135513",
            "backupMethod": "manual",
            "graphId": "4c5f882d-a813-4d78-a8e3-6d3212ddd121",
            "graph_name": "ges060803_nodelete",
            "graphStatus": "200",
            "graphSizeTypeIndex": "1",
            "dataStoreVersion": "2.2.21",
            "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,
            "encrypted": false
        },
        {
            "id": "7ed3f51d-816d-4651-9129-fe21b64b5c91",
            "name": "ges060803_nodelete_20210609203323_auto",
            "backupMethod": "auto",
            "graphId": "4c5f882d-a813-4d78-a8e3-6d3212ddd121",
            "graph_name": "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,
            "encrypted": false
        },
        {
            "id": "604bfb46-04dd-45fc-a9ae-df24a0705b9d",
            "name": "ges060802_nodelete-20210608135523",
            "backupMethod": "manual",
            "graphId": "9b9a05c2-0cdb-41ac-b55f-93caffb0519a",
            "graph_name": "ges060802_nodelete",
            "graphStatus": "400",
            "graphSizeTypeIndex": "0",
            "dataStoreVersion": "2.2.23",
            "arch": "x86_64",
            "status": "success",
            "startTimestamp": 1623160524000,
            "startTime": "2021-06-08T13:55:24",
            "endTimestamp": 1623160577000,
            "endTime": "2021-06-08T13:56:17",
            "size": 1,
            "duration": 53,
            "encrypted": false
        }
    ]
}

Status code: 400

Bad Request

{
  "errorCode" : "GES.7006",
  "errorMessage" : "The underlying graph engine has internal error."
}

Status Code

Status Code	Description
200	Request sent.
400	Request error.
401	Authentication failed.
403	No operation permission.
404	No resources found.
500	Internal service error.
503	Service unavailable.