Help Center> Graph Engine Service> API Reference> Management Plane APIs> Backup Management APIs> Adding a Backup(1.0.0)
View PDF

Adding a Backup(1.0.0)

Function

This API is used to add a backup. If data in the current graph is incorrect or faulty, you can start the backup graph to restore the data.

URI

  • URI format 
    POST /v1.0/{project_id}/graphs/{graph_id}/backups
  • 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

Request

  • Request example 
    POST https://Endpoint/v1.0/{project_id}/graphs/{graph_id}/backups

Response

Table 2 describes the response parameters.
Table 2 Parameter description

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.

job_id

String

ID of the graph backup job.

NOTE:

You can view the job execution status and obtain the return result by querying the job ID. For details, see Task Center APIs.
  • Response example (successful request) 
    Http Status Code: 200
{ 
  "jobId":"ff8080815f9a3c84015f9a438ff70001"
}
  • Response example (failed request) 
    Http Status Code: 400
{
    "errorCode": "GES.7000",
    "errorMessage": "The graph does not exist or has been deleted."
}

Return Value

  • Normal

    200

  • Abnormal
    Table 3 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.
Parent topic: Backup Management APIs