Updated on 2025-03-05 GMT+08:00

Adding a Backup

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

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

graph_id

Yes

String

Graph ID

Request Parameters

Table 2 Parameters in the request header

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

Used to obtain the permission to use APIs. For details about how to obtain the token, see Authentication of Management Plane APIs. The value of X-Subject-Token in the response header is the token.

Response Parameters

Status code: 200

Table 3 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 code.

  • If execution succeeds, this parameter may be left blank.
  • If execution fails, this parameter is used to display the error code.

jobId

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.

Example Request

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

Example Response

Example response with status code 200:

OK

{
    "jobId": "2c9080c48e55a6ba018e59e7d63600fb",
    "backupId": "105788ca-05da-454e-8cb0-9b95d2eec3a6"
}

Status code: 400

Bad Request

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

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.