Help Center/ Graph Engine Service/ API Reference (Kuala Lumpur Region)/ Management Plane APIs/ Backup Management APIs/ Viewing the Backup List of a Graph
Updated on 2022-08-08 GMT+08:00
View PDF
Share

Viewing the Backup List of a Graph

Function

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

URI

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

Table 1 URI parameters

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
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. The token can be obtained by calling the IAM API. (The token is the value of X-Subject-Token in the response header.)

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

errorMessage

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

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

Integer

Total number of backups. This field is left blank when the request fails.

backupList

Array of backup objects

List of backups of the specified graph under the current project. 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

graphName

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. The value true indicates that the backup data is encrypted. The default value false indicates that the backup data is not encrypted.

Example Request

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

Example Response

Example response with status code 200:

OK

{
    "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,
            "encrypted": false
        },
        {
            "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,
            "encrypted": false
        }
    ]
}

Status code: 400

Bad Request

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

Status Code

Status Code

Description

200

OK

400

Bad Request
Parent topic: Backup Management APIs